@mikezimm/fps-core-v7/lib/restAPIs/logging/Analytics/getAnalyticsAPI.d.ts

Library of reusable core interfaces, types and constants migrated from fps-library-v2

import { IFpsItemsReturn } from '../../../components/molecules/process-results/IFpsItemsReturn';
import { IFpsSpHttpServiceMIN } from '../../../components/molecules/SpHttp/Sp/IFpsSpHttpServiceMIN';
/**
 * 2024-09-29:  Migrated from src\pnpjs\SourceItems\getSourceItems.ts
 *
 * getSourceItems calls the Pnp function to get the results which returns the raw error.
 * This function then will convert the error into the helpful error and return the standard IItemsError object.
 *    const UniquePermsFilter = 'HasUniqueRoleAssignments eq true';
 *    const UniquePermsHiddenFilter = `${ UniquePermsFilter }  and Hidden eq false`;
 *
 * import { getAnalyticsAPI } from "@mikezimm/fps-core-v7/lib/restAPIs/logging/Analytics/getAnalyticsAPI";
 *
 * @param sourceProps
 * @param autoExapnd = true is for normal sourceProps, use false if you have custom logic for expands such as Drilldown
 * @param alertMe
 * @param consoleLog
 * @param expandFormats = optional - use FieldValuesAsText and FieldValuesAsHtml to add to the expands for return format regardless of autoExpand
 * @param ItemId  -- optional to add a number Id greater than -1 to use the .getById filter, over-rides any restFilter on sourceProps
 * @returns
 */
export declare function getAnalyticsAPI(fpsSpService: IFpsSpHttpServiceMIN, analyticsWeb: string, analyticsList: string, WebID: string, ListID: string | null | undefined, fetchOnlyThisList: boolean | undefined, theseColumns: any[] | undefined, top: number | undefined, baseErrorTrace: string): Promise<IFpsItemsReturn>;
//# sourceMappingURL=getAnalyticsAPI.d.ts.map