Classes
Enumerations
Interfaces
TypeAliases

Rate this page:

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.
componentTypeMaybe<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.
componentTypesMaybe<CompassComponentTypesQueryResult>Retreives a list of component types. 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.
searchTeamLabelsMaybe<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.
searchTeamsMaybe<CompassSearchTeamsConnectionResult>Search teams within a target site. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" 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.

Rate this page: