import { BaseService } from './base.js';
import { BacklinksSummaryParams, AnchorsParams, GetActiveBacklinksParams, GetReferringDomainsParams, GetLostBacklinksParams, GetTopAnchorsParams, GetTopPagesByBacklinksParams, GetBacklinksIntersectionParams, GetActiveOutlinksParams, GetActiveOutlinkDomainsParams, GetThreatBacklinksParams } from '../utils/validation.js';
import { BacklinksSummaryResponse, AnchorsResponse, ActiveBacklinksResponse, ReferringDomainsResponse, LostBacklinksResponse, TopAnchorsResponse, TopPagesByBacklinksResponse, BacklinksIntersectionResponse, ActiveOutlinksResponse, ActiveOutlinkDomainsResponse, ThreatBacklinksResponse, SerpstatRequest } from '../types/serpstat.js';
import { logger } from '../utils/logger.js';
export class BacklinksService extends BaseService {
async getBacklinksSummary(params: BacklinksSummaryParams): Promise<BacklinksSummaryResponse> {
logger.info('Getting backlinks summary', { query: params.query, searchType: params.searchType });
const request: SerpstatRequest = {
id: `backlinks_summary_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getSummaryV2',
params,
};
const response = await this.makeRequest<BacklinksSummaryResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved backlinks summary', {
leftLines: response.result.summary_info.left_lines
});
return response.result;
}
async getAnchors(params: AnchorsParams): Promise<AnchorsResponse> {
logger.info('Getting anchors', { query: params.query, searchType: params.searchType });
const request: SerpstatRequest = {
id: `anchors_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getAnchors',
params,
};
const response = await this.makeRequest<AnchorsResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved anchors', {
leftLines: response.result.summary_info.left_lines,
count: response.result.summary_info.count
});
return response.result;
}
async getActiveBacklinks(params: GetActiveBacklinksParams): Promise<ActiveBacklinksResponse> {
logger.info('Getting active backlinks', { query: params.query, searchType: params.searchType });
const request: SerpstatRequest = {
id: `active_backlinks_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getNewBacklinks',
params,
};
const response = await this.makeRequest<ActiveBacklinksResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved active backlinks', {
leftLines: response.result.summary_info.left_lines,
count: response.result.summary_info.count,
total: response.result.summary_info.total
});
return response.result;
}
async getReferringDomains(params: GetReferringDomainsParams): Promise<ReferringDomainsResponse> {
logger.info('Getting referring domains', { query: params.query, searchType: params.searchType });
const request: SerpstatRequest = {
id: `referring_domains_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getRefDomains',
params,
};
const response = await this.makeRequest<ReferringDomainsResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved referring domains', {
leftLines: response.result.summary_info.left_lines,
count: response.result.summary_info.count,
total: response.result.summary_info.total
});
return response.result;
}
async getLostBacklinks(params: GetLostBacklinksParams): Promise<LostBacklinksResponse> {
logger.info('Getting lost backlinks', {
query: params.query,
searchType: params.searchType,
sort: params.sort,
page: params.page,
size: params.size
});
const request: SerpstatRequest = {
id: `lost_backlinks_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getLostBacklinks',
params,
};
const response = await this.makeRequest<LostBacklinksResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved lost backlinks', {
leftLines: response.result.summary_info.left_lines,
count: response.result.summary_info.count,
total: response.result.summary_info.total
});
return response.result;
}
async getTopAnchors(params: GetTopAnchorsParams): Promise<TopAnchorsResponse> {
logger.info('Getting top anchors', {
query: params.query,
searchType: params.searchType
});
const request: SerpstatRequest = {
id: `top_anchors_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getTopAnchors',
params,
};
const response = await this.makeRequest<TopAnchorsResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved top anchors', {
leftLines: response.result.summary_info.left_lines,
dataCount: response.result.data.length,
uniqueAnchors: response.result.summary_info.unique_anchors
});
return response.result;
}
async getTopPagesByBacklinks(params: GetTopPagesByBacklinksParams): Promise<TopPagesByBacklinksResponse> {
logger.info('Getting top pages by backlinks', {
query: params.query,
searchType: params.searchType,
sort: params.sort,
page: params.page,
size: params.size
});
const request: SerpstatRequest = {
id: `top_pages_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getTopPages',
params,
};
const response = await this.makeRequest<TopPagesByBacklinksResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved top pages by backlinks', {
leftLines: response.result.summary_info.left_lines,
count: response.result.summary_info.count,
total: response.result.summary_info.total
});
return response.result;
}
async getBacklinksIntersection(params: GetBacklinksIntersectionParams): Promise<BacklinksIntersectionResponse> {
logger.info('Getting backlinks intersection', {
query: params.query,
intersect: params.intersect,
sort: params.sort,
page: params.page,
size: params.size
});
const request: SerpstatRequest = {
id: `backlinks_intersection_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getIntersect',
params,
};
const response = await this.makeRequest<BacklinksIntersectionResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved backlinks intersection', {
leftLines: response.result.summary_info.left_lines,
count: response.result.summary_info.count,
total: response.result.summary_info.total
});
return response.result;
}
async getActiveOutlinks(params: GetActiveOutlinksParams): Promise<ActiveOutlinksResponse> {
logger.info('Getting active outlinks', {
query: params.query,
searchType: params.searchType,
sort: params.sort,
page: params.page,
size: params.size
});
const request: SerpstatRequest = {
id: `active_outlinks_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getOutlinks',
params,
};
const response = await this.makeRequest<ActiveOutlinksResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved active outlinks', {
leftLines: response.result.summary_info.left_lines,
count: response.result.summary_info.count,
total: response.result.summary_info.total
});
return response.result;
}
async getActiveOutlinkDomains(params: GetActiveOutlinkDomainsParams): Promise<ActiveOutlinkDomainsResponse> {
logger.info('Getting active outlink domains', {
query: params.query,
searchType: params.searchType,
sort: params.sort,
page: params.page,
size: params.size
});
const request: SerpstatRequest = {
id: `active_outlink_domains_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getOutDomains',
params,
};
const response = await this.makeRequest<ActiveOutlinkDomainsResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved active outlink domains', {
leftLines: response.result.summary_info.left_lines,
count: response.result.summary_info.count,
total: response.result.summary_info.total
});
return response.result;
}
async getThreatBacklinks(params: GetThreatBacklinksParams): Promise<ThreatBacklinksResponse> {
logger.info('Getting threat backlinks', {
query: params.query,
searchType: params.searchType,
sort: params.sort,
page: params.page,
size: params.size
});
const request: SerpstatRequest = {
id: `threat_backlinks_${Date.now()}`,
method: 'SerpstatBacklinksProcedure.getThreatsLinks',
params,
};
const response = await this.makeRequest<ThreatBacklinksResponse>(request);
if (!response.result) {
throw new Error('No result data received from Serpstat API');
}
logger.info('Successfully retrieved threat backlinks', {
leftLines: response.result.summary_info.left_lines,
count: response.result.summary_info.count,
total: response.result.summary_info.total
});
return response.result;
}
}
