Classes

Rate this page:

Type Aliases

AddCompassComponentLabelsInput

Accepts input for adding labels to a component.

Property NameTypeDescription
componentIdStringThe ID of the component to add the labels to.
labelNamesArray<String>The collection of labels to add to the component.

AddCompassComponentLabelsPayload

The payload returned after adding labels to a component.

Property NameTypeDescription
__typenameLiteral
addedLabelsMaybe<Array<CompassComponentLabel>>The collection of labels that were added to the component.
componentDetailsMaybe<CompassComponent>The details of the component that was mutated.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

ApplyCompassScorecardToComponentPayload

The payload returned from applying a scorecard to a component.

Property NameTypeDescription
__typenameLiteral
componentDetailsMaybe<CompassComponent>The details of the component that was mutated.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

AttachCompassComponentDataManagerInput

Accepts input to attach a data manager to a component.

Property NameTypeDescription
componentIdStringThe ID of the component to attach a data manager to.
externalSourceURLInputMaybe<Any>An URL of the external source of the component's data.

AttachCompassComponentDataManagerPayload

The payload returned from attaching a data manager to a component.

Property NameTypeDescription
__typenameLiteral
componentDetailsMaybe<CompassComponent>The details of the component that was mutated.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassAcknowledgeAnnouncementInput

Accepts input for acknowledging an announcement.

Property NameTypeDescription
announcementIdStringThe ID of the announcement being acknowledged.
componentIdStringThe ID of the component that is acknowledging the announcement.

CompassAcknowledgeAnnouncementPayload

The payload returned after acknowledging an announcement.

Property NameTypeDescription
__typenameLiteral
acknowledgementMaybe<CompassAnnouncementAcknowledgement>The announcement acknowledgement.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassAddTeamLabelsInput

Accepts input for adding labels to a team.

Property NameTypeDescription
cloudIdStringThe cloud ID of the target site.
labelsArray<String>A list of labels that should be added to the team.
teamIdStringThe unique identifier (ID) of the target team.

CompassAddTeamLabelsPayload

The payload returned after adding labels to a team.

Property NameTypeDescription
__typenameLiteral
addedLabelsMaybe<Array<CompassTeamLabel>>A list of labels that were added to the team.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanA flag indicating whether the mutation was successful.

CompassAlertEvent

Property NameTypeDescription
__typenameLiteral
alertPropertiesCompassAlertEventPropertiesAlert Properties
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassAlertEventProperties

################################################################################################################### CompassAlertEventPropertiesInput The list of properties of the alert event.

Property NameTypeDescription
idStringThe ID of the alert.

CompassAnnouncement

An announcement communicates news or updates relating to a component.

Property NameTypeDescription
__typenameLiteral
acknowledgementsMaybe<Array<CompassAnnouncementAcknowledgement>>The list of acknowledgements that are required for this announcement.
componentMaybe<CompassComponent>The component that posted the announcement.
descriptionMaybe<String>The description of the announcement.
idStringThe ID of the announcement.
targetDateMaybe<Any>The date on which the updates in the announcement will take effect.
titleMaybe<String>The title of the announcement.

CompassAnnouncementAcknowledgement

Tracks whether or not a component has acknowledged an announcement.

Property NameTypeDescription
__typenameLiteral
componentMaybe<CompassComponent>The component that needs to acknowledge.
hasAcknowledgedMaybe<Boolean>Whether the component has acknowledged the announcement or not.

CompassBuildEvent

Property NameTypeDescription
__typenameLiteral
buildPropertiesCompassBuildEventPropertiesBuild Properties
descriptionMaybe<String>The description of the build event.
displayNameStringThe name of the build event.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the build event.

CompassBuildEventPipeline

Property NameTypeDescription
__typenameLiteral
displayNameMaybe<String>The name of the build event pipeline.
pipelineIdStringThe ID of the build event pipeline.
urlMaybe<String>The URL to the build event pipeline.

CompassBuildEventPipelineInput

The build event pipeline.

Property NameTypeDescription
displayNameInputMaybe<String>The name of the build event pipeline.
pipelineIdStringThe ID of the build event pipeline.
urlInputMaybe<String>The URL to the build event pipeline.

CompassBuildEventProperties

Property NameTypeDescription
__typenameLiteral
completedAtMaybe<Any>Time the build completed.
pipelineMaybe<CompassBuildEventPipeline>The build event pipeline
startedAtAnyTime the build started.
stateCompassBuildEventStateThe state of the build

CompassBuildEventPropertiesInput

The list of properties of the build event.

Property NameTypeDescription
completedAtInputMaybe<Any>Time the build completed.
pipelineCompassBuildEventPipelineInputThe build event pipeline.
startedAtAnyTime the build started.
stateCompassBuildEventStateThe state of the build.

CompassCatalogMutationApi

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
__typenameLiteral
acknowledgeAnnouncementMaybe<CompassAcknowledgeAnnouncementPayload>Acknowledges an announcement on behalf of a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
addComponentLabelsMaybe<AddCompassComponentLabelsPayload>Adds a collection of labels to a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
addTeamLabelsMaybe<CompassAddTeamLabelsPayload>Adds labels to a team within Compass. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
applyScorecardToComponentMaybe<ApplyCompassScorecardToComponentPayload>Applies a scorecard to a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
attachComponentDataManagerMaybe<AttachCompassComponentDataManagerPayload>Attach a data manager to a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
attachEventSourceMaybe<AttachEventSourcePayload>Attaches an event source to a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createAnnouncementMaybe<CompassCreateAnnouncementPayload>Creates an announcement for a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
createCompassEventMaybe<CompassCreateEventsPayload>Creates a compass event. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createComponentMaybe<CreateCompassComponentPayload>Creates a new component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createComponentExternalAliasMaybe<CreateCompassComponentExternalAliasPayload>Creates an external alias for a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createComponentLinkMaybe<CreateCompassComponentLinkPayload>Creates a link for a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createComponentSubscriptionMaybe<CompassCreateComponentSubscriptionPayload>Creates a subscription to a component for current user. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
createCustomFieldDefinitionMaybe<CompassCreateCustomFieldDefinitionPayload>Creates a custom field definition. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createDeploymentEventMaybe<CreateDeploymentEventsPayload>Creates a deployment event. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
createEventSourceMaybe<CreateEventSourcePayload>Creates an event source. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createMetricDefinitionMaybe<CompassCreateMetricDefinitionPayload>Creates a metric definition on a Compass site. A metric definition provides details for a metric source. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
createMetricSourceMaybe<CompassCreateMetricSourcePayload>Creates a metric source for a component. A metric source contains values providing numerical data about a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
createRelationshipMaybe<CreateCompassRelationshipPayload>Creates a new relationship between two components. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createScorecardMaybe<CreateCompassScorecardPayload>Creates a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createScorecardCriteriasMaybe<CreateCompassScorecardCriteriasPayload>Adds criteria to a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createStarredComponentMaybe<CreateCompassStarredComponentPayload>Creates a starred relationship between a user and a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createTeamCheckinMaybe<CompassCreateTeamCheckinPayload>Creates a checkin for a team. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
deleteAnnouncementMaybe<CompassDeleteAnnouncementPayload>Deletes an existing announcement from a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
deleteComponentMaybe<DeleteCompassComponentPayload>Deletes an existing component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteComponentExternalAliasMaybe<DeleteCompassComponentExternalAliasPayload>Deletes an existing external alias from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteComponentLinkMaybe<DeleteCompassComponentLinkPayload>Deletes an existing link from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteComponentSubscriptionMaybe<CompassDeleteComponentSubscriptionPayload>Deletes a subscription to a component for current user. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
deleteCustomFieldDefinitionMaybe<CompassDeleteCustomFieldDefinitionPayload>Deletes a custom field definition, along with all values associated with the definition. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteEventSourceMaybe<DeleteEventSourcePayload>Deletes an event source and all the corresponding events from that event source. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteMetricDefinitionMaybe<CompassDeleteMetricDefinitionPayload>Deletes a metric definition including the metric sources it defines from a Compass site. Metric sources contain values providing numerical data about a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
deleteMetricSourceMaybe<CompassDeleteMetricSourcePayload>Deletes a metric source including the metric values it contains. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
deleteRelationshipMaybe<DeleteCompassRelationshipPayload>Deletes an existing relationship between two components. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteScorecardMaybe<DeleteCompassScorecardPayload>Deletes a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteScorecardCriteriasMaybe<DeleteCompassScorecardCriteriasPayload>Deletes criteria from a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteStarredComponentMaybe<DeleteCompassStarredComponentPayload>Deletes a starred relationship between a user and a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteTeamCheckinMaybe<CompassDeleteTeamCheckinPayload>Deletes a checkin from a team. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
detachComponentDataManagerMaybe<DetachCompassComponentDataManagerPayload>Detach a data manager from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
detachEventSourceMaybe<DetachEventSourcePayload>Detaches an event source from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
insertMetricValueMaybe<CompassInsertMetricValuePayload>Inserts a metric value in a metric source for a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
insertMetricValueByExternalIdMaybe<CompassInsertMetricValueByExternalIdPayload>Inserts metric values into metric sources using the external ID of the source, except when a Forge app created the metric, and you're not that same Forge app. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
removeComponentLabelsMaybe<RemoveCompassComponentLabelsPayload>Removes a collection of existing labels from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
removeScorecardFromComponentMaybe<RemoveCompassScorecardFromComponentPayload>Removes a scorecard from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
removeTeamLabelsMaybe<CompassRemoveTeamLabelsPayload>Removes labels from a team within Compass. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
synchronizeLinkAssociationsMaybe<CompassSynchronizeLinkAssociationsPayload>Synchronizes event and metric information for the current set of component links on a Compass site using the provided Forge app. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
unlinkExternalSourceMaybe<UnlinkExternalSourcePayload>Clean external aliases and data managers pertaining to an externalSource This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateAnnouncementMaybe<CompassUpdateAnnouncementPayload>Updates an announcement from a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
updateComponentMaybe<UpdateCompassComponentPayload>Updates an existing component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateComponentDataManagerMetadataMaybe<UpdateCompassComponentDataManagerMetadataPayload>Update a data manager of a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateComponentLinkMaybe<UpdateCompassComponentLinkPayload>Updates a link from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateComponentTypeMaybe<UpdateCompassComponentTypePayload>Updates a component's type. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
updateCustomFieldDefinitionMaybe<CompassUpdateCustomFieldDefinitionPayload>Updates a custom field definition. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateMetricDefinitionMaybe<CompassUpdateMetricDefinitionPayload>Updates a metric definition on a Compass site. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
updateScorecardMaybe<UpdateCompassScorecardPayload>Updates a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateScorecardCriteriasMaybe<UpdateCompassScorecardCriteriasPayload>Updates criteria on a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateTeamCheckinMaybe<CompassUpdateTeamCheckinPayload>Updates a checkin for a team. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.

CompassCatalogMutationApiAcknowledgeAnnouncementArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassAcknowledgeAnnouncementInput

CompassCatalogMutationApiAddComponentLabelsArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputAddCompassComponentLabelsInput

CompassCatalogMutationApiAddTeamLabelsArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassAddTeamLabelsInput

CompassCatalogMutationApiApplyScorecardToComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
componentIdString
scorecardIdString

CompassCatalogMutationApiAttachComponentDataManagerArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputAttachCompassComponentDataManagerInput

CompassCatalogMutationApiAttachEventSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputAttachEventSourceInput

CompassCatalogMutationApiCreateAnnouncementArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateAnnouncementInput

CompassCatalogMutationApiCreateCompassEventArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateEventInput

CompassCatalogMutationApiCreateComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
cloudIdString
inputCreateCompassComponentInput

CompassCatalogMutationApiCreateComponentExternalAliasArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateCompassComponentExternalAliasInput

CompassCatalogMutationApiCreateComponentLinkArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateCompassComponentLinkInput

CompassCatalogMutationApiCreateComponentSubscriptionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateComponentSubscriptionInput

CompassCatalogMutationApiCreateCustomFieldDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateCustomFieldDefinitionInput

CompassCatalogMutationApiCreateDeploymentEventArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateDeploymentEventInput

CompassCatalogMutationApiCreateEventSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateEventSourceInput

CompassCatalogMutationApiCreateMetricDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateMetricDefinitionInput

CompassCatalogMutationApiCreateMetricSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateMetricSourceInput

CompassCatalogMutationApiCreateRelationshipArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateCompassRelationshipInput

CompassCatalogMutationApiCreateScorecardArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
cloudIdString
inputCreateCompassScorecardInput

CompassCatalogMutationApiCreateScorecardCriteriasArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateCompassScorecardCriteriasInput
scorecardIdString

CompassCatalogMutationApiCreateStarredComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
cloudIdString
inputCreateCompassStarredComponentInput

CompassCatalogMutationApiCreateTeamCheckinArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateTeamCheckinInput

CompassCatalogMutationApiDeleteAnnouncementArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteAnnouncementInput

CompassCatalogMutationApiDeleteComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteCompassComponentInput

CompassCatalogMutationApiDeleteComponentExternalAliasArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteCompassComponentExternalAliasInput

CompassCatalogMutationApiDeleteComponentLinkArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteCompassComponentLinkInput

CompassCatalogMutationApiDeleteComponentSubscriptionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteComponentSubscriptionInput

CompassCatalogMutationApiDeleteCustomFieldDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteCustomFieldDefinitionInput

CompassCatalogMutationApiDeleteEventSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteEventSourceInput

CompassCatalogMutationApiDeleteMetricDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteMetricDefinitionInput

CompassCatalogMutationApiDeleteMetricSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteMetricSourceInput

CompassCatalogMutationApiDeleteRelationshipArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteCompassRelationshipInput

CompassCatalogMutationApiDeleteScorecardArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
scorecardIdString

CompassCatalogMutationApiDeleteScorecardCriteriasArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteCompassScorecardCriteriasInput
scorecardIdString

CompassCatalogMutationApiDeleteStarredComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
cloudIdString
inputDeleteCompassStarredComponentInput

CompassCatalogMutationApiDeleteTeamCheckinArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteTeamCheckinInput

CompassCatalogMutationApiDetachComponentDataManagerArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDetachCompassComponentDataManagerInput

CompassCatalogMutationApiDetachEventSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDetachEventSourceInput

CompassCatalogMutationApiInsertMetricValueArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassInsertMetricValueInput

CompassCatalogMutationApiInsertMetricValueByExternalIdArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassInsertMetricValueByExternalIdInput

CompassCatalogMutationApiRemoveComponentLabelsArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputRemoveCompassComponentLabelsInput

CompassCatalogMutationApiRemoveScorecardFromComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
componentIdString
scorecardIdString

CompassCatalogMutationApiRemoveTeamLabelsArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassRemoveTeamLabelsInput

CompassCatalogMutationApiSynchronizeLinkAssociationsArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputInputMaybe<CompassSynchronizeLinkAssociationsInput>

CompassCatalogMutationApiUnlinkExternalSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUnlinkExternalSourceInput

CompassCatalogMutationApiUpdateAnnouncementArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassUpdateAnnouncementInput

CompassCatalogMutationApiUpdateComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassComponentInput

CompassCatalogMutationApiUpdateComponentDataManagerMetadataArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassComponentDataManagerMetadataInput

CompassCatalogMutationApiUpdateComponentLinkArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassComponentLinkInput

CompassCatalogMutationApiUpdateComponentTypeArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassComponentTypeInput

CompassCatalogMutationApiUpdateCustomFieldDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassUpdateCustomFieldDefinitionInput

CompassCatalogMutationApiUpdateMetricDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassUpdateMetricDefinitionInput

CompassCatalogMutationApiUpdateScorecardArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassScorecardInput
scorecardIdString

CompassCatalogMutationApiUpdateScorecardCriteriasArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassScorecardCriteriasInput
scorecardIdString

CompassCatalogMutationApiUpdateTeamCheckinArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassUpdateTeamCheckinInput

CompassCatalogQueryApi

Top level wrapper for Compass Query API

Property NameTypeDescription
__typenameLiteral
componentMaybe<CompassComponentResult>Retrieves a single component by its internal ID. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
componentByExternalAliasMaybe<CompassComponentResult>Retrieves a single component by its external alias. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
customFieldDefinitionsMaybe<CompassCustomFieldDefinitionsResult>Retrieves custom field definitions by component type. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
eventSourceMaybe<CompassEventSourceResult>Retrieve a single event source by its external ID and event type. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
fieldDefinitionsByComponentTypeMaybe<CompassFieldDefinitionsResult>Retrieves field definitions by component type. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
metricDefinitionMaybe<CompassMetricDefinitionResult>Retrieves a single metric definition by its internal ID. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
metricDefinitionsMaybe<CompassMetricDefinitionsQueryResult>A collection of metric definitions on a Compass site. A metric definition provides details for a metric source. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
metricValuesTimeSeriesMaybe<CompassMetricValuesTimeseriesResult>Retrieve a bucketed time-series of metric values by metricSourceId. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
scorecardMaybe<CompassScorecardResult>Retrieves a scorecard by its unique identifier (ID). This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
scorecardsMaybe<CompassScorecardsQueryResult>Retrieves available scorecards. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
searchComponentLabelsMaybe<CompassComponentLabelsQueryResult>Searches for all component labels within Compass. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
searchComponentsMaybe<CompassComponentQueryResult>Searches for Compass components. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
starredComponentsMaybe<CompassStarredComponentQueryResult>Retrieve all starred components based on the user id. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
teamCheckinsMaybe<Array<CompassTeamCheckin>>A collection of checkins posted by a team; sorted by most recent. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
teamDataMaybe<CompassTeamDataResult>Compass-specific data about a team. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.

CompassCatalogQueryApiComponentArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
idString

CompassCatalogQueryApiComponentByExternalAliasArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
externalIDString
externalSourceInputMaybe<String>

CompassCatalogQueryApiCustomFieldDefinitionsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
queryCompassCustomFieldDefinitionsQuery

CompassCatalogQueryApiEventSourceArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
eventTypeCompassEventType
externalEventSourceIdString

CompassCatalogQueryApiFieldDefinitionsByComponentTypeArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
inputCompassComponentType

CompassCatalogQueryApiMetricDefinitionArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
metricDefinitionIdString

CompassCatalogQueryApiMetricDefinitionsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
queryCompassMetricDefinitionsQuery

CompassCatalogQueryApiMetricValuesTimeSeriesArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
metricSourceIdString

CompassCatalogQueryApiScorecardArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
idString

CompassCatalogQueryApiScorecardsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
queryInputMaybe<CompassScorecardsQuery>

CompassCatalogQueryApiSearchComponentLabelsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
queryInputMaybe<CompassSearchComponentLabelsQuery>

CompassCatalogQueryApiSearchComponentsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
queryInputMaybe<CompassSearchComponentQuery>

CompassCatalogQueryApiStarredComponentsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
queryInputMaybe<CompassStarredComponentQuery>

CompassCatalogQueryApiTeamCheckinsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
inputCompassTeamCheckinsInput

CompassCatalogQueryApiTeamDataArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
inputCompassTeamDataInput

CompassChangeMetadata

Metadata about who created or updated the object and when.

Property NameTypeDescription
__typenameLiteral
createdAtMaybe<Any>The date and time when the object was created.
createdByMaybe<User>The user who created the object.
lastUserModificationAtMaybe<Any>The date and time when the object was last updated.
lastUserModificationByMaybe<User>The user who last updated the object.

CompassComponent

A component represents a software development artifact tracked in Compass.

Property NameTypeDescription
__typenameLiteral
announcementsMaybe<Array<CompassAnnouncement>>A collection of announcements posted by the component. Note that the 'X-ExperimentalApi: compass-prototype' HTTP header below is required in addition to the 'X-ExperimentalApi: compass-beta' HTTP header. Set both the headers for this field.
applicableScorecardsMaybe<Array<CompassScorecard>>A collection of scorecards applicable to a component.
changeMetadataCompassChangeMetadataMetadata about who created the component and when.
customFieldsMaybe<Array<CompassCustomField>>A collection of custom fields for storing data about the component.
dataManagerMaybe<CompassComponentDataManager>The external integration that manages data for this component.
descriptionMaybe<String>The description of the component.
eventSourcesMaybe<Array<EventSource>>The event sources associated to the component.
eventsMaybe<CompassEventsQueryResult>The events associated to the component.
externalAliasesMaybe<Array<CompassExternalAlias>>A collection of aliases that represent the component in external systems.
fieldsMaybe<Array<CompassField>>A collection of fields for storing data about the component.
idStringThe unique identifier (ID) of the component.
labelsMaybe<Array<CompassComponentLabel>>A collection of labels that provide additional contextual information about the component.
linksMaybe<Array<CompassLink>>A collection of links to other entities on the internet.
metricSourcesMaybe<CompassComponentMetricSourcesQueryResult>A collection of metric sources, which contain values providing numerical data about the component. Note that the 'X-ExperimentalApi: compass-prototype' HTTP header below is required in addition to the 'X-ExperimentalApi: compass-beta' HTTP header. Set both the headers for this field.
nameStringThe name of the component.
ownerIdMaybe<String>The unique identifier (ID) of the team that owns the component.
relationshipsMaybe<CompassRelationshipConnectionResult>A collection of relationships between one component with other components in Compass. Only relationships of the same direction will be returned, defaulting to OUTWARD.
scorecardScoreMaybe<CompassScorecardScore>Returns the calculated total score for a given scorecard applied to this component.
scorecardScoresMaybe<Array<CompassScorecardScore>>A collection of scorecard scores applied to a component.
scorecardsMaybe<Array<CompassScorecard>>A collection of scorecards applied to a component.
typeCompassComponentTypeThe type of component.
viewerSubscriptionMaybe<CompassViewerSubscription>Component viewer subscription.

CompassComponentEventsArgs

A component represents a software development artifact tracked in Compass.

Property NameTypeDescription
queryInputMaybe<CompassEventsQuery>

CompassComponentMetricSourcesArgs

A component represents a software development artifact tracked in Compass.

Property NameTypeDescription
queryInputMaybe<CompassComponentMetricSourcesQuery>

CompassComponentRelationshipsArgs

A component represents a software development artifact tracked in Compass.

Property NameTypeDescription
queryInputMaybe<CompassRelationshipQuery>

CompassComponentScorecardScoreArgs

A component represents a software development artifact tracked in Compass.

Property NameTypeDescription
queryInputMaybe<CompassComponentScorecardScoreQuery>

CompassComponentDataManager

An external integration that manages data for a particular component.

Property NameTypeDescription
__typenameLiteral
ecosystemAppIdStringThe unique identifier (ID) of the ecosystem app acting as a component data manager.
externalSourceURLMaybe<Any>An URL of the external source.
lastSyncEventMaybe<ComponentSyncEvent>Details about the last sync event to this component.

CompassComponentLabel

A label provides additional contextual information about a component.

Property NameTypeDescription
__typenameLiteral
nameMaybe<String>The name of the label.

CompassComponentLabelsQueryResult

CompassComponentMetricSourcesConnection

A connection that returns a paginated collection of metric sources.

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<CompassMetricSourceEdge>>A list of edges which contain a metric source and a cursor.
nodesMaybe<Array<CompassMetricSource>>A list of metric sources.
pageInfoPageInfoPagination information such as the start and end cursor of this page, and whether there is a next and previous page.

CompassComponentMetricSourcesQuery

The query to get the metric sources of a component.

Property NameTypeDescription
afterInputMaybe<String>Returns results after the specified cursor.
firstInputMaybe<Number>The number of results to return in the query. The default is 10.

CompassComponentMetricSourcesQueryResult

CompassComponentQueryResult

CompassComponentResult

CompassComponentScorecardScoreQuery

Scorecard score on a component for a scorecard.

Property NameTypeDescription
scorecardIdStringThe unique identifier (ID) of the scorecard.

CompassCreateAlertEventInput

An alert event.

Property NameTypeDescription
alertPropertiesCompassAlertEventPropertiesInputAlert Properties
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateAnnouncementInput

Accepts input for creating a component announcement.

Property NameTypeDescription
componentIdStringThe ID of the component to create an announcement for.
descriptionInputMaybe<String>The description of the announcement.
targetDateAnyThe date on which the changes in the announcement will take effect.
titleStringThe title of the announcement.

CompassCreateAnnouncementPayload

The payload returned after creating a component announcement.

Property NameTypeDescription
__typenameLiteral
createdAnnouncementMaybe<CompassAnnouncement>The created announcement.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCreateBuildEventInput

A build event.

Property NameTypeDescription
buildPropertiesCompassBuildEventPropertiesInputBuild Properties
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateComponentSubscriptionInput

Input for creating a component subscription.

Property NameTypeDescription
componentIdStringThe ID of the component being subscribed.

CompassCreateComponentSubscriptionPayload

The payload returned from creating a component subscription.

Property NameTypeDescription
__typenameLiteral
errorsMaybe<Array<MutationError>>A list of errors that occurred during subscribing.
successBooleanWhether user subscribed to the component successfully.

CompassCreateCustomBooleanFieldDefinitionInput

Accepts input for creating a custom boolean field definition.

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to create a custom boolean field definition for.
componentTypesArray<CompassComponentType>The component types the custom boolean field applies to.
descriptionInputMaybe<String>The description of the custom boolean field.
nameStringThe name of the custom boolean field.

CompassCreateCustomEventInput

A custom event.

Property NameTypeDescription
customEventPropertiesCompassCustomEventPropertiesInputCustom Event Properties
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateCustomFieldDefinitionInput

Accepts input for creating a custom field definition. You must provide exactly one of the fields in this input type.

Property NameTypeDescription
booleanFieldDefinitionInputMaybe<CompassCreateCustomBooleanFieldDefinitionInput>Input for creating a custom boolean field definition.
numberFieldDefinitionInputMaybe<CompassCreateCustomNumberFieldDefinitionInput>Input for creating a custom number field definition.
textFieldDefinitionInputMaybe<CompassCreateCustomTextFieldDefinitionInput>Input for creating a custom text field definition.

CompassCreateCustomFieldDefinitionPayload

The payload returned from creating a custom field definition.

Property NameTypeDescription
__typenameLiteral
customFieldDefinitionMaybe<CompassCustomFieldDefinition>The created custom field definition.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCreateCustomNumberFieldDefinitionInput

Accepts input for creating a custom number field definition.

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to create a custom number field definition for.
componentTypesArray<CompassComponentType>The component types the custom number field applies to.
descriptionInputMaybe<String>The description of the custom number field.
nameStringThe name of the custom number field.

CompassCreateCustomTextFieldDefinitionInput

Accepts input for creating a custom text field definition.

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to create a custom text field definition for.
componentTypesArray<CompassComponentType>The component types the custom text field applies to.
descriptionInputMaybe<String>The description of the custom text field.
nameStringThe name of the custom text field.

CompassCreateDeploymentEventInput

A deployment event.

Property NameTypeDescription
deploymentPropertiesCompassCreateDeploymentEventPropertiesInputDeployment Properties
descriptionStringThe description of the deployment event.
displayNameStringThe name of the deployment event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the deployment event.

CompassCreateDeploymentEventPropertiesInput

The list of properties of the deployment event.

Property NameTypeDescription
completedAtInputMaybe<Any>The time this deployment was completed at.
environmentCompassDeploymentEventEnvironmentInputThe environment where the deployment event has occurred.
pipelineCompassDeploymentEventPipelineInputThe deployment event pipeline.
sequenceNumberAnyThe sequence number for the deployment.
startedAtInputMaybe<Any>The time this deployment was started at.
stateCompassDeploymentEventStateThe state of the deployment.

CompassCreateEventInput

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to create the event for.
eventCompassEventInput

CompassCreateEventsPayload

Property NameTypeDescription
__typenameLiteral
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCreateFlagEventInput

A flag event.

Property NameTypeDescription
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
flagPropertiesCompassCreateFlagEventPropertiesInputFlag Properties
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateFlagEventPropertiesInput

The list of properties of the flag event.

Property NameTypeDescription
idStringThe ID of the flag.
statusInputMaybe<String>Status of the flag

CompassCreateHasCustomBooleanFieldScorecardCriteriaInput

Accepts input to create a scorecard criterion checking the value of a specified custom boolean field.

Property NameTypeDescription
booleanComparatorCompassCriteriaBooleanComparatorOptionsThe comparison operation to be performed.
booleanComparatorValueBooleanThe value that the field is compared to.
customFieldDefinitionIdStringThe ID of the component custom boolean field to check the value of.
weightNumberThe weight that will be used in determining the aggregate score.

CompassCreateHasCustomNumberFieldScorecardCriteriaInput

Accepts input to create a scorecard criterion checking the value of a specified custom number field.

Property NameTypeDescription
customFieldDefinitionIdStringThe ID of the component custom number field to check the value of.
numberComparatorCompassCriteriaNumberComparatorOptionsThe comparison operation to be performed between the field and comparator value.
numberComparatorValueNumberThe threshold value that the field is compared to.
weightNumberThe weight that will be used in determining the aggregate score.

CompassCreateHasCustomTextFieldScorecardCriteriaInput

Accepts input to create a scorecard criterion checking the value of a specified custom text field.

Property NameTypeDescription
customFieldDefinitionIdStringThe ID of the component custom text field to check the value of.
weightNumberThe weight that will be used in determining the aggregate score.

CompassCreateIncidentEventInput

An incident event.

Property NameTypeDescription
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
incidentPropertiesCompassCreateIncidentEventPropertiesInputThe list of properties of the incident event.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateIncidentEventPropertiesInput

The list of properties of the incident event.

Property NameTypeDescription
endTimeInputMaybe<Any>The time when the incident ended
idStringThe ID of the incident.
severityInputMaybe<CompassIncidentEventSeverityInput>The severity of the incident
startTimeAnyThe time when the incident started
stateCompassIncidentEventStateThe state of the incident.

CompassCreateLifecycleEventInput

A lifecycle event.

Property NameTypeDescription
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
lifecyclePropertiesCompassLifecycleEventInputPropertiesLifecycle Properties
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateMetricDefinitionInput

The input for creating a metric definition.

Property NameTypeDescription
cloudIdStringThe cloud ID of the Compass site to create a metric definition on.
descriptionInputMaybe<String>The description of the metric definition.
formatInputMaybe<CompassMetricDefinitionFormatInput>The format option for applying to the display of metric values.
nameStringThe name of the metric definition.

CompassCreateMetricDefinitionPayload

The payload returned from creating a metric definition.

Property NameTypeDescription
__typenameLiteral
createdMetricDefinitionMaybe<CompassMetricDefinition>The created metric definition.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCreateMetricSourceInput

The input to create a metric source.

Property NameTypeDescription
componentIdStringThe ID of the component to create a metric source on.
derivedInputMaybe<Boolean>Whether the metric source is derived from Compass events or not.
externalMetricSourceIdStringThe unique identifier (ID) of the metric source that is external to the Compass site, for example, a Bitbucket repository ID.
metricDefinitionIdStringThe ID of the metric definition which defines the metric source.
urlInputMaybe<String>The URL of the metric source.

CompassCreateMetricSourcePayload

The payload returned from creating a metric source.

Property NameTypeDescription
__typenameLiteral
createdMetricSourceMaybe<CompassMetricSource>The metric source that is created.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCreatePushEventInput

A push event.

Property NameTypeDescription
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
pushEventPropertiesCompassPushEventInputPropertiesThe list of properties of the push event.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateTeamCheckinActionInput

Accepts input for creating team checkin's action item.

Property NameTypeDescription
actionTextStringThe text of the team checkin action item.
completedInputMaybe<Boolean>Whether the action is completed or not.

CompassCreateTeamCheckinInput

Accepts input for creating a checkin.

Property NameTypeDescription
actionsInputMaybe<Array<CompassCreateTeamCheckinActionInput>>A list of action items to be created with the checkin.
cloudIdStringThe cloud ID of the site to update a checkin on.
moodNumberThe mood of the checkin.
response1InputMaybe<String>The response to the question 1 of the team checkin.
response1RichTextInputMaybe<CompassCreateTeamCheckinResponseRichText>The response to the question 1 of the team checkin in a rich text format.
response2InputMaybe<String>The response to the question 2 of the team checkin.
response2RichTextInputMaybe<CompassCreateTeamCheckinResponseRichText>The response to the question 2 of the team checkin in a rich text format.
response3InputMaybe<String>The response to the question 3 of the team checkin.
response3RichTextInputMaybe<CompassCreateTeamCheckinResponseRichText>The response to the question 3 of the team checkin in a rich text format.
teamIdStringThe unique identifier (ID) of the team that did the checkin.

CompassCreateTeamCheckinPayload

The payload returned after creating a component announcement.

Property NameTypeDescription
__typenameLiteral
createdTeamCheckinMaybe<CompassTeamCheckin>Details of the created team checkin.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCreateTeamCheckinResponseRichText

Accepts input for creating team checkin responses with rich text.

Property NameTypeDescription
adfInputMaybe<String>Input for a team checkin response in Atlassian Document Format.

CompassCustomBooleanField

A custom field containing a boolean value.

Property NameTypeDescription
__typenameLiteral
booleanValueMaybe<Boolean>The boolean value contained in the custom field on a component.
definitionMaybe<CompassCustomBooleanFieldDefinition>The definition of the custom field containing a boolean value.

CompassCustomBooleanFieldDefinition

The definition of a custom field containing a boolean value.

Property NameTypeDescription
__typenameLiteral
componentTypesMaybe<Array<CompassComponentType>>The component types the custom boolean field applies to.
descriptionMaybe<String>The description of the custom boolean field.
idStringThe ID of the custom boolean field definition.
nameMaybe<String>The name of the custom boolean field.

CompassCustomBooleanFieldInput

Accepts input for setting a boolean value on a custom field.

Property NameTypeDescription
booleanValueBooleanThe boolean value contained in the custom field on a component.
definitionIdStringThe ID of the custom boolean field definition.

CompassCustomEvent

Property NameTypeDescription
__typenameLiteral
customEventPropertiesCompassCustomEventPropertiesCustom Event Properties
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassCustomEventProperties

################################################################################################################### COMPASS CUSTOM EVENT ###################################################################################################################

Property NameTypeDescription
__typenameLiteral
iconMaybe<CompassCustomEventIcon>The icon for the custom event.
idStringThe ID of the custom event.

CompassCustomEventPropertiesInput

The list of properties of the custom event.

Property NameTypeDescription
iconCompassCustomEventIconThe icon for the custom event.
idStringThe ID of the custom event.

CompassCustomField

A custom field contains data about the component.

Property NameTypeDescription
definitionMaybe<CompassCustomFieldDefinition>The definition of the custom field.

CompassCustomFieldDefinition

Defines a custom field that may be applied to multiple component types. A custom field must be applied to at least one component type.

Property NameTypeDescription
componentTypesMaybe<Array<CompassComponentType>>The component types the custom field applies to.
descriptionMaybe<String>The description of the custom field.
idStringThe ID of the custom field definition.
nameMaybe<String>The name of the custom field.

CompassCustomFieldDefinitionEdge

An edge that contains a custom field definition and a cursor.

Property NameTypeDescription
__typenameLiteral
cursorStringThe cursor of the custom field definition.
nodeMaybe<CompassCustomFieldDefinition>The custom field definition.

CompassCustomFieldDefinitionsConnection

A connection that returns a paginated collection of custom field definitions.

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<CompassCustomFieldDefinitionEdge>>A list of edges which contain a custom field definition and a cursor.
nodesMaybe<Array<CompassCustomFieldDefinition>>A list of custom field definitions.
pageInfoPageInfoPagination information such as the start and end cursor of this page, and whether there is a next and previous page.

CompassCustomFieldDefinitionsQuery

The query for retrieving custom field definitions on a Compass site.

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to retrieve custom field definitions from.
componentTypesInputMaybe<Array<CompassComponentType>>Optional filter to search for custom field definitions applied to any of the specified component types. Returns all custom field definitions by default.

CompassCustomFieldDefinitionsResult

CompassCustomFieldInput

Accepts input for setting a custom field value. You must provide exactly one of the fields in this input type.

Property NameTypeDescription
booleanFieldInputMaybe<CompassCustomBooleanFieldInput>Input for setting a value on a custom field containing a boolean value.
numberFieldInputMaybe<CompassCustomNumberFieldInput>Input for setting a value on a custom field containing a number.
textFieldInputMaybe<CompassCustomTextFieldInput>Input for setting a value on a custom field containing a text string.

CompassCustomFieldScorecardCriteria

Property NameTypeDescription
idStringThe ID of the scorecard criterion.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassCustomFieldScorecardCriteriaScorecardCriteriaScoreArgs

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassCustomNumberField

A custom field containing a number.

Property NameTypeDescription
__typenameLiteral
definitionMaybe<CompassCustomNumberFieldDefinition>The definition of the custom field containing a number.
numberValueMaybe<Number>The number contained in the custom field on a component.

CompassCustomNumberFieldDefinition

The definition of a custom field containing a number.

Property NameTypeDescription
__typenameLiteral
componentTypesMaybe<Array<CompassComponentType>>The component types the custom number field applies to.
descriptionMaybe<String>The description of the custom number field.
idStringThe ID of the custom number field definition.
nameMaybe<String>The name of the custom number field.

CompassCustomNumberFieldInput

Accepts input for setting a number on a custom field.

Property NameTypeDescription
definitionIdStringThe ID of the custom number field definition.
numberValueInputMaybe<Number>The number contained in the custom field on a component.

CompassCustomTextField

A custom field containing a text string.

Property NameTypeDescription
__typenameLiteral
definitionMaybe<CompassCustomTextFieldDefinition>The definition of the custom field containing a text string.
textValueMaybe<String>The text string contained in the custom field on a component.

CompassCustomTextFieldDefinition

The definition of a custom field containing a text string.

Property NameTypeDescription
__typenameLiteral
componentTypesMaybe<Array<CompassComponentType>>The component types the custom text field applies to.
descriptionMaybe<String>The description of the custom text field.
idStringThe ID of the custom text field definition.
nameMaybe<String>The name of the custom text field.

CompassCustomTextFieldInput

Accepts input for setting a text string on a custom field.

Property NameTypeDescription
definitionIdStringThe ID of the custom text field definition.
textValueInputMaybe<String>The text string contained in the custom field on a component.

CompassDeleteAnnouncementInput

Accepts input for deleting a component announcement.

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to delete an announcement from.
idStringThe ID of the announcement to delete.

CompassDeleteAnnouncementPayload

The payload returned after deleting a component announcement.

Property NameTypeDescription
__typenameLiteral
deletedAnnouncementIdMaybe<String>The ID of the announcement that was deleted.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassDeleteComponentSubscriptionInput

Accepts input for delete a subscription.

Property NameTypeDescription
componentIdStringThe ID of the component to unsubscribe.

CompassDeleteComponentSubscriptionPayload

Payload returned from stop watching a component.

Property NameTypeDescription
__typenameLiteral
errorsMaybe<Array<MutationError>>A list of errors that occurred during unsubscribing.
successBooleanWhether user unsubscribed from the component successfully.

CompassDeleteCustomFieldDefinitionInput

Accepts input for deleting a custom field definition, along with all values associated with the definition.

Property NameTypeDescription
idStringThe ID of the custom field definition to be deleted.

CompassDeleteCustomFieldDefinitionPayload

The payload returned from deleting a custom field definition.

Property NameTypeDescription
__typenameLiteral
customFieldDefinitionIdMaybe<String>The ID of the deleted custom field definition.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassDeleteMetricDefinitionInput

The input to delete a metric definition.

Property NameTypeDescription
idStringThe ID of the metric definition to be deleted.

CompassDeleteMetricDefinitionPayload

The payload returned from updating a metric definition.

Property NameTypeDescription
__typenameLiteral
deletedMetricDefinitionIdMaybe<String>The ID of the deleted metric definition.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassDeleteMetricSourceInput

The input to delete a metric source.

Property NameTypeDescription
idStringThe ID of the metric source to be deleted.

CompassDeleteMetricSourcePayload

The payload returned from deleting a metric source.

Property NameTypeDescription
__typenameLiteral
deletedMetricSourceIdMaybe<String>The ID of the metric source that is deleted.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassDeleteTeamCheckinActionInput

Accepts input for deleting a team checkin.

Property NameTypeDescription
idStringThe ID of the team checkin item to delete.

CompassDeleteTeamCheckinInput

Accepts input for deleting a team checkin.

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to update a checkin on.
idStringThe ID of the team checkin to delete.

CompassDeleteTeamCheckinPayload

The payload returned after deleting a team checkin.

Property NameTypeDescription
__typenameLiteral
deletedTeamCheckinIdMaybe<String>ID of the checkin that was deleted.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassDeploymentEvent

Property NameTypeDescription
__typenameLiteral
deploymentPropertiesCompassDeploymentEventPropertiesDeployment Properties
deploymentSequenceNumberMaybe<Any>The sequence number for the deployment.
descriptionMaybe<String>The description of the deployment event.
displayNameStringThe name of the deployment event.
environmentMaybe<CompassDeploymentEventEnvironment>The environment where the deployment event has occurred.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
pipelineMaybe<CompassDeploymentEventPipeline>The deployment event pipeline.
stateMaybe<CompassDeploymentEventState>The state of the deployment.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the deployment event.

CompassDeploymentEventEnvironment

Property NameTypeDescription
__typenameLiteral
categoryMaybe<CompassDeploymentEventEnvironmentCategory>The type of environment where the deployment event occurred.
displayNameMaybe<String>The display name of the environment where the deployment event occurred.
environmentIdMaybe<String>The ID of the environment where the deployment event occurred.

CompassDeploymentEventEnvironmentInput

The environment where the deployment event has occurred.

Property NameTypeDescription
categoryCompassDeploymentEventEnvironmentCategoryThe type of environment where the deployment event occurred.
displayNameStringThe display name of the environment where the deployment event occurred.
environmentIdStringThe ID of the environment where the deployment event occurred.

CompassDeploymentEventPipeline

Property NameTypeDescription
__typenameLiteral
displayNameMaybe<String>The name of the deployment event pipeline.
pipelineIdMaybe<String>The ID of the deployment event pipeline.
urlMaybe<String>The URL of the deployment event pipeline.

CompassDeploymentEventPipelineInput

The deployment event pipeline.

Property NameTypeDescription
displayNameStringThe name of the deployment event pipeline.
pipelineIdStringThe ID of the deployment event pipeline.
urlStringThe URL of the deployment event pipeline.

CompassDeploymentEventProperties

Property NameTypeDescription
__typenameLiteral
completedAtMaybe<Any>The time this deployment was completed at.
environmentMaybe<CompassDeploymentEventEnvironment>The environment where the deployment event has occurred.
pipelineMaybe<CompassDeploymentEventPipeline>The deployment event pipeline.
sequenceNumberMaybe<Any>The sequence number for the deployment.
startedAtMaybe<Any>The time this deployment was started at.
stateMaybe<CompassDeploymentEventState>The state of the deployment.

CompassEnumField

Property NameTypeDescription
__typenameLiteral
definitionMaybe<CompassFieldDefinition>The definition of the field.
valueMaybe<Array<String>>The value of the field.

CompassEnumFieldDefinitionOptions

Property NameTypeDescription
__typenameLiteral
defaultMaybe<Array<String>>The default option for field definition. If null, the field is not required.
valuesMaybe<Array<String>>Possible values of the field definition.

CompassEnumFieldValueInput

Property NameTypeDescription
valueInputMaybe<Array<String>>

CompassEvent

Property NameTypeDescription
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassEventConnection

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<Maybe<CompassEventEdge>>>
nodesMaybe<Array<CompassEvent>>
pageInfoPageInfo

CompassEventEdge

Property NameTypeDescription
__typenameLiteral
cursorString
nodeMaybe<CompassEvent>

CompassEventInput

The type of event. One and only one of the fields in this input type must be provided.

CompassEventSourceResult

CompassEventTimeParameters

Property NameTypeDescription
endAtInputMaybe<Any>The time to end querying for event data.
startFromInputMaybe<Any>The time to begin querying for event data.

CompassEventsInEventSourceQuery

Property NameTypeDescription
afterInputMaybe<String>Returns the events after the specified cursor position.
firstInputMaybe<Number>The first N number of events to return in the query.
timeParametersInputMaybe<CompassEventTimeParameters>Returns the events after that match the CompassEventTimeParameters.

CompassEventsQuery

Property NameTypeDescription
afterInputMaybe<String>Returns the events after the specified cursor position.
eventTypesInputMaybe<Array<CompassEventType>>The list of event types.
firstInputMaybe<Number>The first N number of events to return in the query.
timeParametersInputMaybe<CompassEventTimeParameters>Returns the events after that match the CompassEventTimeParameters.

CompassEventsQueryResult

CompassExternalAlias

An alias of the component in an external system.

Property NameTypeDescription
__typenameLiteral
externalAliasIdStringThe ID of the component in an external system.
externalSourceMaybe<String>The external system hosting the component.

CompassExternalAliasInput

Property NameTypeDescription
externalIdStringThe ID of the component in the external source
externalSourceInputMaybe<String>The external system hosting the component

CompassField

A field represents data about a component.

Property NameTypeDescription
definitionMaybe<CompassFieldDefinition>The definition of the field.

CompassFieldDefinition

The schema of a field.

Property NameTypeDescription
__typenameLiteral
descriptionStringThe description of the field.
idStringThe unique identifier (ID) of the field definition.
nameStringThe name of the field.
optionsCompassFieldDefinitionOptionsThe options for the field definition.
typeCompassFieldTypeThe type of field.

CompassFieldDefinitionOptions

CompassFieldDefinitions

Property NameTypeDescription
__typenameLiteral
definitionsArray<CompassFieldDefinition>

CompassFieldDefinitionsResult

CompassFieldValueInput

Property NameTypeDescription
enumInputMaybe<CompassEnumFieldValueInput>

CompassFlagEvent

Property NameTypeDescription
__typenameLiteral
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
flagPropertiesCompassFlagEventPropertiesFlag Properties
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassFlagEventProperties

################################################################################################################### CompassHasCustomBooleanFieldScorecardCriteria The configuration for a scorecard criterion checking the value of a specified custom boolean field.

Property NameTypeDescription
__typenameLiteral
booleanComparatorMaybe<CompassCriteriaBooleanComparatorOptions>The comparison operation to be performed between the field and comparator value.
booleanComparatorValueMaybe<Boolean>The value that the field is compared to.
customFieldDefinitionMaybe<CompassCustomBooleanFieldDefinition>The definition of the custom boolean field to check the value of.
idStringThe ID of the scorecard criterion.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasCustomBooleanFieldScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion checking the value of a specified custom boolean field.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasCustomNumberFieldScorecardCriteria

The configuration for a scorecard criterion checking the value of a specified custom number field.

Property NameTypeDescription
__typenameLiteral
customFieldDefinitionMaybe<CompassCustomNumberFieldDefinition>The definition of the custom number field to check the value of.
idStringThe ID of the scorecard criterion.
numberComparatorMaybe<CompassCriteriaNumberComparatorOptions>The comparison operation to be performed between the field and comparator value.
numberComparatorValueMaybe<Number>The threshold value that the field is compared to.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasCustomNumberFieldScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion checking the value of a specified custom number field.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasCustomTextFieldScorecardCriteria

The configuration for a scorecard criterion checking the value of a specified custom text field.

Property NameTypeDescription
__typenameLiteral
customFieldDefinitionMaybe<CompassCustomTextFieldDefinition>The definition of the custom text field to check the value of.
idStringThe ID of the scorecard criterion.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasCustomTextFieldScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion checking the value of a specified custom text field.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasDescriptionScorecardCriteria

The configuration for a scorecard criterion representing the presence of a description.

Property NameTypeDescription
__typenameLiteral
idString
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a given component
weightNumber

CompassHasDescriptionScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion representing the presence of a description.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasFieldScorecardCriteria

The configuration for a scorecard criterion representing the presence of a field, for example, 'Has Tier'.

Property NameTypeDescription
__typenameLiteral
fieldDefinitionCompassFieldDefinitionThe target of a relationship, for example, 'Owner' if 'Has Owner'.
idStringThe ID of the scorecard criterion.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasFieldScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion representing the presence of a field, for example, 'Has Tier'.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasLinkScorecardCriteria

The configuration for a scorecard criterion representing the presence of a link, for example, 'Has Repository', or 'Has Documentation'.

Property NameTypeDescription
__typenameLiteral
idStringThe ID of the scorecard criterion.
linkTypeCompassLinkTypeThe type of link, for example 'Repository' if 'Has Repository'.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasLinkScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion representing the presence of a link, for example, 'Has Repository', or 'Has Documentation'.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasMetricValueScorecardCriteria

The configuration for a scorecard criterion checking the value of a specified metric name.

Property NameTypeDescription
__typenameLiteral
comparatorCompassCriteriaNumberComparatorOptionsThe comparison operation to be performed between the metric and comparator value.
comparatorValueNumberThe threshold value that the metric is compared to.
idStringThe ID of the scorecard criterion.
metricDefinitionMaybe<CompassMetricDefinition>The definition of the component metric to check the value of.
metricDefinitionIdStringThe ID of the component metric to check the value of.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasMetricValueScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion checking the value of a specified metric name.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasOwnerScorecardCriteria

Configuration for a scorecard criteria representing the presence of an owner

Property NameTypeDescription
__typenameLiteral
idStringThe ID of the scorecard criterion.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasOwnerScorecardCriteriaScorecardCriteriaScoreArgs

Configuration for a scorecard criteria representing the presence of an owner

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassIncidentEvent

Property NameTypeDescription
__typenameLiteral
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
incidentPropertiesCompassIncidentEventPropertiesThe list of properties of the incident event.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassIncidentEventProperties

################################################################################################################### COMPASS INCIDENT EVENT ###################################################################################################################

Property NameTypeDescription
__typenameLiteral
endTimeMaybe<Any>The time when the incident ended
idStringThe ID of the incident.
severityMaybe<CompassIncidentEventSeverity>The severity of the incident
startTimeMaybe<Any>The time when the incident started
stateMaybe<CompassIncidentEventState>The state of the incident.

CompassIncidentEventSeverity

The severity of an incident

Property NameTypeDescription
__typenameLiteral
labelMaybe<String>The label to use for displaying the severity of the incident
levelMaybe<CompassIncidentEventSeverityLevel>The severity level. A severity level of 'ONE' is the most severe, and a level of 'FIVE' is the least severe.

CompassIncidentEventSeverityInput

The severity of an incident

Property NameTypeDescription
labelInputMaybe<String>The label to use for displaying the severity of the incident
levelInputMaybe<CompassIncidentEventSeverityLevel>The severity level. A severity level of 'ONE' is the most severe, and a level of 'FIVE' is the least severe.

CompassInsertMetricValueByExternalIdInput

The input to insert a metric value in all metric sources that match a specific combination of metricDefinitionId and externalMetricSourceId.

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to insert a metric value for.
externalMetricSourceIdStringThe ID of the metric source that is external to the Compass site, for example, a Bitbucket repository ID.
metricDefinitionIdStringThe ID of the metric definition for which the value applies.
valueCompassMetricValueInputThe metric value to be inserted.

CompassInsertMetricValueByExternalIdPayload

The payload returned from inserting a metric value by external ID.

Property NameTypeDescription
__typenameLiteral
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassInsertMetricValueInput

The input to insert a metric value into a metric source.

Property NameTypeDescription
metricSourceIdStringThe ID of the metric source to insert the value into.
valueCompassMetricValueInputThe metric value to insert.

CompassInsertMetricValuePayload

The payload returned from inserting a metric value.

Property NameTypeDescription
__typenameLiteral
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
metricSourceMaybe<CompassMetricSource>The metric source that the value was inserted into.
successBooleanWhether the mutation was successful or not.

CompassLifecycleEvent