export type LLMrefsOptions = { /** * The API key to use for requests. * If preferred, you can also set the `LLMREFS_API_KEY` environment variable instead. * Sign up for an API key at https://llmrefs.com/signup. */ apiKey?: string; }; export type ListOrganizationsOptions = {}; export type ListOrganizationsResponse = Array<{ id: string; name: string; }>; export type ListProjectsOptions = { organizationId: string; }; export type ListProjectsResponse = Array<{ id: string; name: string; domain: string; }>; export type ListKeywordsOptions = { organizationId: string; projectId: string; }; export type ListKeywordsResponse = Array<{ id: string; value: string; location: string; searchVolume: number | null; }>; export type ListSearchEnginesOptions = {}; export type ListSearchEnginesResponse = Array<{ value: string; name: string; }>; export type ListLocationsOptions = {}; export type ListLocationsResponse = Array<{ value: string; name: string; }>; export type GetKeywordOptions = { keywordId: string; organizationId: string; projectId: string; filters?: { searchEngines?: string[]; }; }; export type GetKeywordResponse = { id: string; value: string; location: string; searchVolume: number | null; rankings: Array<{ rank: number; brandId: string; shareOfVoice: string; averagePosition: string; sources: string[]; }>; sources: Array<{ source: string; mentionRate: string; averagePosition: string | null; brandIds: string[]; }>; responses: Array<{ prompt: string; searchEngine: string; text: string; brandsIds: string[]; sources: string[]; }>; brands: Array<{ id: string; name: string; domain: string | null; }>; }; /** * LLMrefs API client. * Full documentation is available at https://llmrefs.com/ai-seo-api. */ export declare class LLMrefs { private readonly _apiKey; constructor(opts?: LLMrefsOptions); organizations: { /** * List organizations. * Returns the full set of all LLMrefs organizations you have access to. */ list: (options?: ListOrganizationsOptions) => Promise; }; projects: { /** * List projects. * Returns the full set of all projects this LLMrefs organization has access to. * @param options - Options including organizationId */ list: (options: ListProjectsOptions) => Promise; }; keywords: { /** * List keywords. * Returns the full set of active keywords this LLMrefs project has access to. * @param options - Options including organizationId and projectId */ list: (options: ListKeywordsOptions) => Promise; /** * List search engines. * Returns the full set of generative AI search engines (LLMs) that are tracked by LLMrefs. */ searchEngines: (options?: ListSearchEnginesOptions) => Promise; /** * List locations. * Returns the full set of available locations that are tracked by LLMrefs. */ locations: (options?: ListLocationsOptions) => Promise; /** * Get keyword data. * Returns the detailed breakdown of the keyword's AI SEO analytics data for the current period. * @param options - Options including keywordId, organizationId, projectId, and optional filters */ get: (options: GetKeywordOptions) => Promise; }; private _fetch; private _buildUrl; private _listOrganizations; private _listProjects; private _listKeywords; private _listSearchEngines; private _listLocations; private _getKeyword; } export default LLMrefs; //# sourceMappingURL=index.d.ts.map