google-trends-api-client/dist/methods/getRelatedTopics.d.ts

An fully typed and easy to use client for the google trends api.

import { GoogleTrendsApiTopic } from '../common';
export interface GoogleTrendsApiRelatedQueryRankedTopic {
    topic: GoogleTrendsApiTopic;
    value: number;
    formattedValue: string;
    hasData?: boolean;
    link: string;
}
/**
 * per google
 * > Users searching for your term also searched for these topics.
 * > You can sort by the following metrics:
 * >  - TOP
 * >    - The most popular topics.
 * >    - Scoring is on a relative scale where a value of 100 is the most commonly searched topic, 50 is a query searched half as often as the most popular topic, and so on.
 * >  - RISING
 * >    - Related topics with the biggest increase in search frequency since the last time period.
 * >    - Results marked "Breakout" had a tremendous increase, probably because these topics are new and had few (if any) prior searches.
 */
export declare const getRelatedTopics: (args_0: import("./getExplorationWidgets").CommonGoogleTrendsApiExplorationParamters & import("../assertions/defineCommonGoogleTrendsApiParametersValue").CommonGoogleTrendsApiParameters, args_1?: import("../common").AgentOptions | undefined) => Promise<{
    top: GoogleTrendsApiRelatedQueryRankedTopic[];
    rising: GoogleTrendsApiRelatedQueryRankedTopic[];
}>;