angles-javascript-client
Version:
This is the javascript client for the Angles Dashboard. It allows you to store your test results.
28 lines (27 loc) • 1.06 kB
TypeScript
import { AxiosInstance } from 'axios';
import { BaseRequests } from './BaseRequests';
import { GroupingPeriods } from "../models/enum/GroupingPeriods";
import { PhaseMetrics } from "../models/response/PhaseMetrics";
import { ScreenshotMetrics } from "../models/response/ScreenshotMetrics";
export declare class MetricRequests extends BaseRequests {
constructor(axiosInstance: AxiosInstance);
/**
* Will retrieve metrics for a specific period and will group it by a specified period
*
* @param teamId
* @param componentId
* @param fromDate
* @param toDate
* @param groupingPeriod
*/
getPhaseMetrics(teamId: string, componentId: string, fromDate: Date, toDate: Date, groupingPeriod: GroupingPeriods): Promise<PhaseMetrics>;
/**
* Will retrieve screenshot metrics grouped by tags and views.
*
* @param view
* @param tag
* @param limit
* @param thumbnail
*/
getScreenshotMetrics(view: string, tag: string, limit: number, thumbnail: boolean): Promise<ScreenshotMetrics>;
}