cloudflare/resources/dns-firewall/analytics/reports/reports.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../../core/resource.js";
import * as BytimesAPI from "./bytimes.js";
import { BaseBytimes, BytimeGetParams, Bytimes } from "./bytimes.js";
import * as AnalyticsReportsAPI from "../../../dns/analytics/reports/reports.js";
import { APIPromise } from "../../../../core/api-promise.js";
import { RequestOptions } from "../../../../internal/request-options.js";
export declare class BaseReports extends APIResource {
    static readonly _key: readonly ['dnsFirewall', 'analytics', 'reports'];
    /**
     * Retrieves a list of summarised aggregate metrics over a given time period.
     *
     * See
     * [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/)
     * for detailed information about the available query parameters.
     *
     * @deprecated This endpoint is deprecated. See [the API deprecation notice](https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-12-09).
     */
    get(dnsFirewallID: string, params: ReportGetParams, options?: RequestOptions): APIPromise<AnalyticsReportsAPI.Report>;
}
export declare class Reports extends BaseReports {
    bytimes: BytimesAPI.Bytimes;
}
export interface ReportGetParams {
    /**
     * Path param: Identifier.
     */
    account_id: string;
    /**
     * Query param: A comma-separated list of dimensions to group results by.
     */
    dimensions?: string;
    /**
     * Query param: Segmentation filter in 'attribute operator value' format.
     */
    filters?: string;
    /**
     * Query param: Limit number of returned metrics.
     */
    limit?: number;
    /**
     * Query param: A comma-separated list of metrics to query.
     */
    metrics?: string;
    /**
     * Query param: Start date and time of requesting data period in ISO 8601 format.
     */
    since?: string;
    /**
     * Query param: A comma-separated list of dimensions to sort by, where each
     * dimension may be prefixed by - (descending) or + (ascending).
     */
    sort?: string;
    /**
     * Query param: End date and time of requesting data period in ISO 8601 format.
     */
    until?: string;
}
export declare namespace Reports {
    export { type ReportGetParams as ReportGetParams };
    export { Bytimes as Bytimes, BaseBytimes as BaseBytimes, type BytimeGetParams as BytimeGetParams };
}
//# sourceMappingURL=reports.d.ts.map