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

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../../core/resource';
import * as BytimesAPI from './bytimes';
import { BaseBytimes, BytimeGetParams, Bytimes } from './bytimes';
import * as AnalyticsReportsAPI from '../../../dns/analytics/reports/reports';
import { APIPromise } from '../../../../core/api-promise';
import { RequestOptions } from '../../../../internal/request-options';
import { path } from '../../../../internal/utils/path';

export class BaseReports extends APIResource {
  static override readonly _key: readonly ['dnsFirewall', 'analytics', 'reports'] = Object.freeze([
    'dnsFirewall',
    'analytics',
    'reports',
  ] as const);

  /**
   * 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> {
    const { account_id, ...query } = params;
    return (
      this._client.get(path`/accounts/${account_id}/dns_firewall/${dnsFirewallID}/dns_analytics/report`, {
        query,
        ...options,
      }) as APIPromise<{ result: AnalyticsReportsAPI.Report }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class Reports extends BaseReports {
  bytimes: BytimesAPI.Bytimes = new BytimesAPI.Bytimes(this._client);
}

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;
}

Reports.Bytimes = Bytimes;
Reports.BaseBytimes = BaseBytimes;

export declare namespace Reports {
  export { type ReportGetParams as ReportGetParams };

  export { Bytimes as Bytimes, BaseBytimes as BaseBytimes, type BytimeGetParams as BytimeGetParams };
}