feat(UA-9134): added the getFailedInstances call in the datahealth resource

src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts

@@ -2,6 +2,8 @@ import ReadServiceResource from '../ReadServiceResource.js';
 import {
     DataHealthEventPayloadResponse,
     DataHealthGetEventPayloadParams,
+    DataHealthGetFailedInstancesParams,
+    DataHealthGetFailedInstancesResponse,
     DataHealthGetGroupDetailParams,
     DataHealthGetGroupDetailResponse,
     DataHealthGetGroupListingParams,
@@ -93,4 +95,13 @@ export default class DataHealth extends ReadServiceResource {
     protected buildPathWithOrg(route: string, queryParams?: any): string {
         return super.buildPath(route, {org: this.api.organizationId, ...queryParams});
     }
+
+    /**
+     * Get failed instances for a data health criterion
+     */
+    getFailedInstances(params: DataHealthGetFailedInstancesParams, args?: RequestInit) {
+        return this.api.get<DataHealthGetFailedInstancesResponse>(
+            this.buildPathWithOrg(`${DataHealth.baseUrl}/criteria/failedInstances`, params),
+        );
+    }
 }

src/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.ts

@@ -310,3 +310,57 @@ export interface DataHealthGetTrackingIdsResponse {
      */
     values: DataHealthFacetValue[];
 }
+
+export interface DataHealthGetFailedInstancesParams extends OrganizationParamParts, TimeRangeParamParts {
+    /**
+     * The data health criterion for which the failed instances should be returned.
+     */
+    criterionId: string;
+    /**
+     * The group for which data health information should be returned.
+     */
+    group: string;
+    /**
+     * The value of the criterion scope for which failed instances should be returned.
+     */
+    scopeValue: string;
+    /**
+     * The tracking IDs for which the results should be returned.
+     */
+    trackingId: string[];
+}
+
+export interface DataHealthGetFailedInstancesResponse extends PaginatedResponse {
+    /**
+     * A collection of failed instances.
+     */
+    failedInstances: DataHealthFailedInstanceEntry[];
+}
+
+export interface DataHealthFailedInstanceEntry {
+    /**
+     * The timestamp of the failed instance.
+     */
+    timestamp: string;
+    /**
+     * The id of the event.
+     */
+    eventId: string;
+    /**
+     * The id of the visit.
+     */
+    visitId: string;
+    /**
+     * The client id of the event.
+     */
+    clientId: string;
+    /**
+     * The scope of the datahealth rule, either event or visit.
+     */
+    scope: DataHealthRuleScope;
+}
+
+/**
+ * The scope of the datahealth rule, either event or visit.
+ */
+type DataHealthRuleScope = 'EVENT' | 'VISIT';

src/resources/UsageAnalytics/Read/DataHealth/tests/DataHealth.spec.ts

@@ -2,6 +2,7 @@ import API from '../../../../../APICore.js';
 import DataHealth from '../DataHealth.js';
 import {
     DataHealthGetEventPayloadParams,
+    DataHealthGetFailedInstancesParams,
     DataHealthGetGroupDetailParams,
     DataHealthGetGroupListingParams,
     DataHealthGetOverviewParams,
@@ -125,4 +126,21 @@ describe('DataHealth', () => {
             );
         });
     });
+
+    describe('getFailedInstances', () => {
+        it('should make a GET call to the data health get tracking id url', () => {
+            const datahealthGetFailedInstancesParams: DataHealthGetFailedInstancesParams = {
+                ...baseParams,
+                criterionId: 'criterion',
+                group: 'group',
+                scopeValue: '',
+                trackingId: [''],
+            };
+            dataHealth.getFailedInstances(datahealthGetFailedInstancesParams);
+            expect(api.get).toHaveBeenCalledTimes(1);
+            expect(api.get).toHaveBeenCalledWith(
+                `${DataHealth.baseUrl}/criteria/failedInstances?org=someOrgId&from=1986-04-26T01%3A23%3A58.000Z&to=1986-04-27T02%3A32%3A15.000Z&criterionId=criterion&group=group`,
+            );
+        });
+    });
 });