cloudflare/resources/radar/ranking/domain.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as DomainAPI from 'cloudflare/resources/radar/ranking/domain';
export declare class Domain extends APIResource {
    /**
     * Gets Domains Rank details. Cloudflare provides an ordered rank for the top 100
     * domains, but for the remainder it only provides ranking buckets like top 200
     * thousand, top one million, etc.. These are available through Radar datasets
     * endpoints.
     */
    get(domain: string, query?: DomainGetParams, options?: Core.RequestOptions): Core.APIPromise<DomainGetResponse>;
    get(domain: string, options?: Core.RequestOptions): Core.APIPromise<DomainGetResponse>;
}
export interface DomainGetResponse {
    details_0: DomainGetResponse.Details0;
}
export declare namespace DomainGetResponse {
    interface Details0 {
        categories: Array<Details0.Category>;
        top_locations: Array<Details0.TopLocation>;
        /**
         * Only available in POPULAR ranking for the most recent ranking.
         */
        bucket?: string;
        rank?: number;
    }
    namespace Details0 {
        interface Category {
            id: number;
            name: string;
            superCategoryId: number;
        }
        interface TopLocation {
            locationCode: string;
            locationName: string;
            rank: number;
        }
    }
}
export interface DomainGetParams {
    /**
     * Array of dates to filter the ranking.
     */
    date?: Array<string | null>;
    /**
     * Format results are returned in.
     */
    format?: 'JSON' | 'CSV';
    /**
     * Limit the number of objects in the response.
     */
    limit?: number;
    /**
     * Array of names that will be used to name the series in responses.
     */
    name?: Array<string>;
    /**
     * The ranking type.
     */
    rankingType?: 'POPULAR' | 'TRENDING_RISE' | 'TRENDING_STEADY';
}
export declare namespace Domain {
    export import DomainGetResponse = DomainAPI.DomainGetResponse;
    export import DomainGetParams = DomainAPI.DomainGetParams;
}
//# sourceMappingURL=domain.d.ts.map