@coveo/platform-client 55.8.0 → 55.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealth.js +15 -7
  2. package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealth.js.map +1 -1
  3. package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealth.js +15 -7
  4. package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealth.js.map +1 -1
  5. package/dist/types/resources/UsageAnalytics/Read/DataHealth/DataHealth.d.ts +14 -8
  6. package/dist/types/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.d.ts +50 -0
  7. package/package.json +1 -1
package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealth.js CHANGED
@@ -7,45 +7,53 @@ class DataHealth extends ReadServiceResource_js_1.default {
7
7
  /**
8
8
  * Get health information about events.
9
9
  */
10
- listEvents(params, args) {
10
+ listEvents(params) {
11
11
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events`, params));
12
12
  }
13
13
  /**
14
14
  * Get original event payload.
15
15
  */
16
- getEventPayload(params, args) {
16
+ getEventPayload(params) {
17
17
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events/payload`, params));
18
18
  }
19
19
  /**
20
20
  * List applicable facet values in the specified time range.
21
21
  */
22
- listFacetValues(params, args) {
22
+ listFacetValues(params) {
23
23
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, params));
24
24
  }
25
25
  /**
26
26
  * Get general data health information.
27
27
  */
28
- getOverview(params, args) {
28
+ getOverview(params) {
29
29
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/overview`, params));
30
30
  }
31
31
  /**
32
32
  * Get health information about groups of validation rules.
33
33
  */
34
- getGroupListing(params, args) {
34
+ getGroupListing(params) {
35
35
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/groups`, params));
36
36
  }
37
37
  /**
38
38
  * Get health information about validation rules of a specific group.
39
39
  */
40
- getGroupDetail(params, args) {
40
+ getGroupDetail(params) {
41
41
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/groups/detail`, params));
42
42
  }
43
43
  /**
44
44
  * Get a list of unique tracking ids.
45
45
  */
46
- getTrackingIds(params, args) {
46
+ getTrackingIds(params) {
47
47
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, { ...params, facet: 'TRACKING_ID' }));
48
48
  }
49
+ /**
50
+ * Get failed instances for a data health criterion
51
+ *
52
+ * @param params Parameters to fetch data health failed instances.
53
+ */
54
+ getFailedInstances(params) {
55
+ return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/criteria/failedInstances`, params));
56
+ }
49
57
  /**
50
58
  * Build the request path, handling the optional `org` query parameter.
51
59
  *
package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealth.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"DataHealth.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts"],"names":[],"mappings":";;;AAAA,+FAA4D;AAkB5D,MAAqB,UAAW,SAAQ,gCAAmB;IACvD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,MAAsC,EAAE,IAAkB;QACjE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC,EAAE,IAAkB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,iBAAiB,EAAE,MAAM,CAAC,CACxE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAsC,EAAE,IAAkB;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAmC,EAAE,IAAkB;QAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,WAAW,EAAE,MAAM,CAAC,CAClE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC,EAAE,IAAkB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC,EAAE,IAAkB;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,CACvE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC,EAAE,IAAkB;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,EAAC,GAAG,MAAM,EAAE,KAAK,EAAE,aAAa,EAAC,CAAC,CAC3F,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACO,gBAAgB,CAAC,KAAa,EAAE,WAAiB;QACvD,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,WAAW,EAAC,CAAC,CAAC;IAClF,CAAC;;AA5EL,6BA6EC"}
1
+ {"version":3,"file":"DataHealth.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts"],"names":[],"mappings":";;;AAAA,+FAA4D;AAoB5D,MAAqB,UAAW,SAAQ,gCAAmB;IACvD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,MAAsC;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,iBAAiB,EAAE,MAAM,CAAC,CACxE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAsC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAmC;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,WAAW,EAAE,MAAM,CAAC,CAClE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,CACvE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,EAAC,GAAG,MAAM,EAAE,KAAK,EAAE,aAAa,EAAC,CAAC,CAC3F,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAA0C;QACzD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,2BAA2B,EAAE,MAAM,CAAC,CAClF,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACO,gBAAgB,CAAC,KAAa,EAAE,WAAiB;QACvD,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,WAAW,EAAC,CAAC,CAAC;IAClF,CAAC;;AAvFL,6BAwFC"}
package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealth.js CHANGED
@@ -4,45 +4,53 @@ export default class DataHealth extends ReadServiceResource {
4
4
  /**
5
5
  * Get health information about events.
6
6
  */
7
- listEvents(params, args) {
7
+ listEvents(params) {
8
8
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events`, params));
9
9
  }
10
10
  /**
11
11
  * Get original event payload.
12
12
  */
13
- getEventPayload(params, args) {
13
+ getEventPayload(params) {
14
14
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events/payload`, params));
15
15
  }
16
16
  /**
17
17
  * List applicable facet values in the specified time range.
18
18
  */
19
- listFacetValues(params, args) {
19
+ listFacetValues(params) {
20
20
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, params));
21
21
  }
22
22
  /**
23
23
  * Get general data health information.
24
24
  */
25
- getOverview(params, args) {
25
+ getOverview(params) {
26
26
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/overview`, params));
27
27
  }
28
28
  /**
29
29
  * Get health information about groups of validation rules.
30
30
  */
31
- getGroupListing(params, args) {
31
+ getGroupListing(params) {
32
32
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/groups`, params));
33
33
  }
34
34
  /**
35
35
  * Get health information about validation rules of a specific group.
36
36
  */
37
- getGroupDetail(params, args) {
37
+ getGroupDetail(params) {
38
38
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/groups/detail`, params));
39
39
  }
40
40
  /**
41
41
  * Get a list of unique tracking ids.
42
42
  */
43
- getTrackingIds(params, args) {
43
+ getTrackingIds(params) {
44
44
  return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, { ...params, facet: 'TRACKING_ID' }));
45
45
  }
46
+ /**
47
+ * Get failed instances for a data health criterion
48
+ *
49
+ * @param params Parameters to fetch data health failed instances.
50
+ */
51
+ getFailedInstances(params) {
52
+ return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/criteria/failedInstances`, params));
53
+ }
46
54
  /**
47
55
  * Build the request path, handling the optional `org` query parameter.
48
56
  *
package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealth.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"DataHealth.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAkB5D,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,mBAAmB;IACvD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,MAAsC,EAAE,IAAkB;QACjE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC,EAAE,IAAkB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,iBAAiB,EAAE,MAAM,CAAC,CACxE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAsC,EAAE,IAAkB;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAmC,EAAE,IAAkB;QAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,WAAW,EAAE,MAAM,CAAC,CAClE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC,EAAE,IAAkB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC,EAAE,IAAkB;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,CACvE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC,EAAE,IAAkB;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,EAAC,GAAG,MAAM,EAAE,KAAK,EAAE,aAAa,EAAC,CAAC,CAC3F,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACO,gBAAgB,CAAC,KAAa,EAAE,WAAiB;QACvD,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,WAAW,EAAC,CAAC,CAAC;IAClF,CAAC"}
1
+ {"version":3,"file":"DataHealth.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAoB5D,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,mBAAmB;IACvD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,MAAsC;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,iBAAiB,EAAE,MAAM,CAAC,CACxE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAsC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAmC;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,WAAW,EAAE,MAAM,CAAC,CAClE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,CACvE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,EAAC,GAAG,MAAM,EAAE,KAAK,EAAE,aAAa,EAAC,CAAC,CAC3F,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAA0C;QACzD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,2BAA2B,EAAE,MAAM,CAAC,CAClF,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACO,gBAAgB,CAAC,KAAa,EAAE,WAAiB;QACvD,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,WAAW,EAAC,CAAC,CAAC;IAClF,CAAC"}
package/dist/types/resources/UsageAnalytics/Read/DataHealth/DataHealth.d.ts CHANGED
@@ -1,35 +1,41 @@
1
1
  import ReadServiceResource from '../ReadServiceResource.js';
2
- import { DataHealthEventPayloadResponse, DataHealthGetEventPayloadParams, DataHealthGetGroupDetailParams, DataHealthGetGroupDetailResponse, DataHealthGetGroupListingParams, DataHealthGetGroupListingResponse, DataHealthGetOverviewParams, DataHealthGetOverviewResponse, DataHealthGetTrackingIdsParams, DataHealthGetTrackingIdsResponse, DataHealthListEventsParameters, DataHealthListEventsResponse, DataHealthListFacetsResponse, DataHealthListFacetValueParams } from './DataHealthInterfaces.js';
2
+ import { DataHealthEventPayloadResponse, DataHealthGetEventPayloadParams, DataHealthGetFailedInstancesParams, DataHealthGetFailedInstancesResponse, DataHealthGetGroupDetailParams, DataHealthGetGroupDetailResponse, DataHealthGetGroupListingParams, DataHealthGetGroupListingResponse, DataHealthGetOverviewParams, DataHealthGetOverviewResponse, DataHealthGetTrackingIdsParams, DataHealthGetTrackingIdsResponse, DataHealthListEventsParameters, DataHealthListEventsResponse, DataHealthListFacetsResponse, DataHealthListFacetValueParams } from './DataHealthInterfaces.js';
3
3
  export default class DataHealth extends ReadServiceResource {
4
4
  static baseUrl: string;
5
5
  /**
6
6
  * Get health information about events.
7
7
  */
8
- listEvents(params: DataHealthListEventsParameters, args?: RequestInit): Promise<DataHealthListEventsResponse>;
8
+ listEvents(params: DataHealthListEventsParameters): Promise<DataHealthListEventsResponse>;
9
9
  /**
10
10
  * Get original event payload.
11
11
  */
12
- getEventPayload(params: DataHealthGetEventPayloadParams, args?: RequestInit): Promise<DataHealthEventPayloadResponse>;
12
+ getEventPayload(params: DataHealthGetEventPayloadParams): Promise<DataHealthEventPayloadResponse>;
13
13
  /**
14
14
  * List applicable facet values in the specified time range.
15
15
  */
16
- listFacetValues(params: DataHealthListFacetValueParams, args?: RequestInit): Promise<DataHealthListFacetsResponse>;
16
+ listFacetValues(params: DataHealthListFacetValueParams): Promise<DataHealthListFacetsResponse>;
17
17
  /**
18
18
  * Get general data health information.
19
19
  */
20
- getOverview(params: DataHealthGetOverviewParams, args?: RequestInit): Promise<DataHealthGetOverviewResponse>;
20
+ getOverview(params: DataHealthGetOverviewParams): Promise<DataHealthGetOverviewResponse>;
21
21
  /**
22
22
  * Get health information about groups of validation rules.
23
23
  */
24
- getGroupListing(params: DataHealthGetGroupListingParams, args?: RequestInit): Promise<DataHealthGetGroupListingResponse>;
24
+ getGroupListing(params: DataHealthGetGroupListingParams): Promise<DataHealthGetGroupListingResponse>;
25
25
  /**
26
26
  * Get health information about validation rules of a specific group.
27
27
  */
28
- getGroupDetail(params: DataHealthGetGroupDetailParams, args?: RequestInit): Promise<DataHealthGetGroupDetailResponse>;
28
+ getGroupDetail(params: DataHealthGetGroupDetailParams): Promise<DataHealthGetGroupDetailResponse>;
29
29
  /**
30
30
  * Get a list of unique tracking ids.
31
31
  */
32
- getTrackingIds(params: DataHealthGetTrackingIdsParams, args?: RequestInit): Promise<DataHealthGetTrackingIdsResponse>;
32
+ getTrackingIds(params: DataHealthGetTrackingIdsParams): Promise<DataHealthGetTrackingIdsResponse>;
33
+ /**
34
+ * Get failed instances for a data health criterion
35
+ *
36
+ * @param params Parameters to fetch data health failed instances.
37
+ */
38
+ getFailedInstances(params: DataHealthGetFailedInstancesParams): Promise<DataHealthGetFailedInstancesResponse>;
33
39
  /**
34
40
  * Build the request path, handling the optional `org` query parameter.
35
41
  *
package/dist/types/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.d.ts CHANGED
@@ -284,4 +284,54 @@ export interface DataHealthGetTrackingIdsResponse {
284
284
  */
285
285
  values: DataHealthFacetValue[];
286
286
  }
287
+ export interface DataHealthGetFailedInstancesParams extends OrganizationParamParts, TimeRangeParamParts, Paginated {
288
+ /**
289
+ * The data health criterion for which the failed instances should be returned.
290
+ */
291
+ criterionId: string;
292
+ /**
293
+ * The group for which data health information should be returned.
294
+ */
295
+ group: string;
296
+ /**
297
+ * Optional value of the criterion scope for which failed instances should be returned.
298
+ */
299
+ scopeValue?: string;
300
+ /**
301
+ * Optional set of tracking IDs for which the results should be returned.
302
+ */
303
+ trackingId?: string[];
304
+ }
305
+ export interface DataHealthGetFailedInstancesResponse extends PaginatedResponse {
306
+ /**
307
+ * A collection of failed instances.
308
+ */
309
+ failedInstances: DataHealthFailedInstanceEntry[];
310
+ }
311
+ export interface DataHealthFailedInstanceEntry {
312
+ /**
313
+ * The timestamp of the failed instance.
314
+ */
315
+ timestamp: string;
316
+ /**
317
+ * The ID of the event.
318
+ */
319
+ eventId: string;
320
+ /**
321
+ * The ID of the visit.
322
+ */
323
+ visitId: string;
324
+ /**
325
+ * The client ID of the event.
326
+ */
327
+ clientId: string;
328
+ /**
329
+ * The scope of the datahealth rule.
330
+ */
331
+ scope: DataHealthRuleScope;
332
+ }
333
+ /**
334
+ * The scope of a datahealth rule.
335
+ */
336
+ type DataHealthRuleScope = 'EVENT' | 'VISIT';
287
337
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/platform-client",
3
- "version": "55.8.0",
3
+ "version": "55.9.0",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "exports": {