Classes
Enumerations
Interfaces
TypeAliases

CompassCatalogQueryApi

Top level wrapper for Compass Query API

Property NameTypeDescription
__typenameLiteral
applicationManagedComponentsMaybe<CompassApplicationManagedComponentsResult>Retrieve all managed components based on user context
assistantAnswerMaybe<CompassAssistantAnswer>Retrieves a Compass assistant answer by its unique identifier (ID).
componentMaybe<CompassComponentResult>Retrieves a single component by its internal ID.
componentByExternalAliasMaybe<CompassComponentResult>Retrieves a single component by its external alias.
componentScorecardRelationshipMaybe<CompassComponentScorecardRelationshipResult>Retrieves a component scorecard relationship.
componentTypeMaybe<CompassComponentTypeResult>Retrieves a single component type by its ID.
componentTypesMaybe<CompassComponentTypesQueryResult>Retrieves a list of component types.
customFieldDefinitionMaybe<CompassCustomFieldDefinitionResult>Retrieves a custom field definition by id.
customFieldDefinitionsMaybe<CompassCustomFieldDefinitionsResult>Retrieves custom field definitions by component type.
eventSourceMaybe<CompassEventSourceResult>Retrieve a single event source by its external ID and event type.
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.
incomingWebhooksMaybe<CompassIncomingWebhooksConnection>Retrieves a list of registered incoming webhooks
metricDefinitionMaybe<CompassMetricDefinitionResult>Retrieves a single metric definition by its internal ID.
metricDefinitionsMaybe<CompassMetricDefinitionsQueryResult>A collection of metric definitions on a Compass site. A metric definition provides details for a metric source.
metricValuesTimeSeriesMaybe<CompassMetricValuesTimeseriesResult>Retrieve a bucketed time-series of metric values by metricSourceId.
scorecardMaybe<CompassScorecardResult>Retrieves a scorecard by its unique identifier (ID).
scorecardsMaybe<CompassScorecardsQueryResult>Retrieves available scorecards.
searchComponentLabelsMaybe<CompassComponentLabelsQueryResult>Searches for all component labels within Compass.
searchComponentsMaybe<CompassComponentQueryResult>Searches for Compass components.
searchTeamLabelsMaybe<CompassSearchTeamLabelsConnectionResult>Search team labels within a target site.
searchTeamsMaybe<CompassSearchTeamsConnectionResult>Search teams within a target site.
starredComponentsMaybe<CompassStarredComponentsResult>Retrieve all starred components based on the user id.
teamCheckinsMaybe<Array<CompassTeamCheckin>>A collection of checkins posted by a team; sorted by most recent.
teamDataMaybe<CompassTeamDataResult>Compass-specific data about a team.
userDefinedParametersMaybe<CompassUserDefinedParametersConnection>Retrieves specified number of user defined parameters for a component

Rate this page: