acquia-dam-sdk/dist/apis/analytics/api.d.ts

Interact with the Acquia DAM API

import { ApiClient } from '../../client/index.js';
import { AnalyticsRequestParams } from './requests.js';
import { ListAssetDownloadsResponse, ListAssetSharesResponse, ListAssetViewsResponse } from './responses.js';

declare class AnalyticsApi {
    private _client;
    /**
     * Create an instance of the AnalyticsApi class.
     *
     * The Analytics endpoints provide information about asset usage from the Insights application. The API will return download, view, and share details for a single asset.
     * Events may take up to 24 hours before appearing in analytics API results.
     * Note: Three years of analytics data is available, starting from January 1, 2021 onward. The default `date_range` filter is from this date until today.
     *
     * @param client Provide an instance of ApiClient.
     */
    constructor(client: ApiClient);
    /**
     * Retrieve a list of Asset Download events
     * @param params Information about the request
     * @returns Promise containing the Download Asset events that meet the request criteria
     * @see {@link https://widenv2.docs.apiary.io/#reference/analytics/analytics/list-asset-downloads}
     */
    listAssetDownloads(params: AnalyticsRequestParams): Promise<ListAssetDownloadsResponse>;
    /**
     * Retrieve a list of Asset Share events
     * @param params Information about the request
     * @returns Promise containing the Share Asset events that meet the request criteria
     * @see {@link https://widenv2.docs.apiary.io/#reference/analytics/analytics/list-asset-shares}
     */
    listAssetShares(params: AnalyticsRequestParams): Promise<ListAssetSharesResponse>;
    /**
     * Retrieve a list of View Asset events
     * @param params Information about the request
     * @returns Promise containing the View Asset events that meet the request criteria
     * @see {@link https://widenv2.docs.apiary.io/#reference/analytics/analytics/list-asset-views}
     */
    listAssetViews(params: AnalyticsRequestParams): Promise<ListAssetViewsResponse>;
}

export { AnalyticsApi };