CompassCatalogQueryApi

Top level wrapper for Compass Query API

Property Name	Type	Description
__typename	Literal
component	Maybe<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.
componentByExternalAlias	Maybe<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.
componentType	Maybe<CompassComponentTypeResult>	Retrieves a single component type by its ID. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
componentTypes	Maybe<CompassComponentTypesQueryResult>	Retreives a list of component types. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
customFieldDefinitions	Maybe<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.
eventSource	Maybe<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.
fieldDefinitionsByComponentType	Maybe<CompassFieldDefinitionsResult>	Retrieves field definitions by component type. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
metricDefinition	Maybe<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.
metricDefinitions	Maybe<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.
metricValuesTimeSeries	Maybe<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.
scorecard	Maybe<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.
scorecards	Maybe<CompassScorecardsQueryResult>	Retrieves available scorecards. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
searchComponentLabels	Maybe<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.
searchComponents	Maybe<CompassComponentQueryResult>	Searches for Compass components. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
searchTeamLabels	Maybe<CompassSearchTeamLabelsConnectionResult>	Search team labels within a target site. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
searchTeams	Maybe<CompassSearchTeamsConnectionResult>	Search teams within a target site. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
teamCheckins	Maybe<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.
teamData	Maybe<CompassTeamDataResult>	Compass-specific data about a team. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.