@coveo/platform-client
Version:
The main goal of this package is to provide an easy to configure and straightforward way of querying Coveo Cloud APIs using JavaScript.
82 lines • 2.96 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
const tslib_1 = require("tslib");
const ReadServiceResource_js_1 = tslib_1.__importDefault(require("../ReadServiceResource.js"));
class DataHealth extends ReadServiceResource_js_1.default {
static baseUrl = '/rest/ua/v15/datahealth';
/**
* Get health information about events.
* @param params
*/
listEvents(params) {
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events`, params));
}
/**
* Get original event payload.
* @param params
*/
getEventPayload(params) {
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events/payload`, params));
}
/**
* List applicable facet values in the specified time range.
* @param params
*/
listFacetValues(params) {
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, params));
}
/**
* Get general data health information.
* @param params
*/
getOverview(params) {
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/overview`, params));
}
/**
* Get health information about groups of validation rules.
* @param params
*/
getGroupListing(params) {
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/groups`, params));
}
/**
* Get health information about validation rules of a specific group.
* @param params
*/
getGroupDetail(params) {
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/groups/detail`, params));
}
/**
* Get a list of unique tracking ids.
* @param params
*/
getTrackingIds(params) {
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, { ...params, facet: 'TRACKING_ID' }));
}
/**
* Get problems about events.
* @param params
*/
getEventsProblems(params) {
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events/problems`, params));
}
/**
* Get failed instances for a data health criterion
* @param params Parameters to fetch data health failed instances.
*/
getFailedInstances(params) {
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/criteria/failedInstances`, params));
}
/**
* Build the request path, handling the optional `org` query parameter.
* @param route The path part of the request.
* @param queryParams Optional query parameters object.
* If this object contains an `org` property, it will override the value from the configuration.
* @returns The request path including formatted query parameters.
*/
buildPathWithOrg(route, queryParams) {
return super.buildPath(route, { org: this.api.organizationId, ...queryParams });
}
}
exports.default = DataHealth;
//# sourceMappingURL=DataHealth.js.map