Ahrefs API reference

New to Corsair? See API access, authentication, and error handling.

Batch Analysis

analyze

batchAnalysis.analyze Get SEO metrics for up to 200 targets in one request Risk: read

await corsair.ahrefs.api.batchAnalysis.analyze({});

Input

Name	Type	Required	Description
`select`	`string[]`	Yes	A list of fields to return.
`order_by`	`string[]`	No	A list of fields to order the results by, with optional direction.
`targets`	`object[]`	Yes	A list of targets to do batch analysis.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`top_countries`	`number`	No	The number of countries to return in the org_traffic_top_by_country field.
`output`	`json`	No	—

targets full type

{
  url: string,
  mode: exact | prefix | domain | subdomains,
  protocol: both | http | https
}[]

Output

Name	Type	Required	Description
`targets`	`object[]`	Yes	—

targets full type

{
  ahrefs_rank?: number | null,
  backlinks?: number | null,
  backlinks_dofollow?: number | null,
  backlinks_internal?: number | null,
  backlinks_nofollow?: number | null,
  backlinks_redirect?: number | null,
  domain_rating?: number | null,
  index?: number | null,
  ip?: string | null,
  linked_domains?: number | null,
  linked_domains_dofollow?: number | null,
  mode?: string | null,
  org_cost?: number | null,
  org_keywords?: number | null,
  org_keywords_1_3?: number | null,
  org_keywords_4_10?: number | null,
  org_keywords_11_20?: number | null,
  org_keywords_21_50?: number | null,
  org_keywords_51_plus?: number | null,
  org_traffic?: number | null,
  org_traffic_top_by_country?: any[] | null,
  outgoing_links?: number | null,
  outgoing_links_dofollow?: number | null,
  paid_ads?: number | null,
  paid_cost?: number | null,
  paid_keywords?: number | null,
  paid_traffic?: number | null,
  protocol?: string | null,
  refdomains?: number | null,
  refdomains_dofollow?: number | null,
  refdomains_nofollow?: number | null,
  refips?: number | null,
  refips_subnets?: number | null,
  url?: string | null,
  url_rating?: number | null
}[]

Brand Radar

aiResponses

brandRadar.aiResponses Brand Radar: get AI assistant answers that mention the brand or competitors Risk: read

await corsair.ahrefs.api.brandRadar.aiResponses({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of fields to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brand`	`string`	No	A comma-separated list of brands to search for.
`competitors`	`string`	No	A comma-separated list of competitors of your brands.
`data_source`	`string`	Yes	Comma-separated chatbot models: chatgpt, google_ai_overviews, google_ai_mode, gemini, perplexity, copilot, claude (custom prompts only), grok, google_ai_overviews_keywords, google_ai_mode_keywords.
`country`	`string`	No	A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`limit`	`number`	No	The number of results to return.
`date`	`string`	No	The date to search for in YYYY-MM-DD format.
`date_compared`	`string`	No	A date to compare date with, in YYYY-MM-DD format.
`order_by`	`relevance \| volume`	No	A column to order the results by.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`ai_responses`	`object[]`	Yes	—

ai_responses full type

{
  brand_sentiment?: any[] | null,
  country?: string | null,
  data_source?: string | null,
  funnel_stage?: string | null,
  intent?: string[] | null,
  last_updated?: string | null,
  links?: any[] | null,
  question?: string | null,
  response?: string | null,
  search_queries?: string[] | null,
  status?: string | null,
  tags?: string[] | null,
  volume?: number | null
}[]

aiResponsesEntities

brandRadar.aiResponsesEntities Brand Radar: get AI assistant answers that mention the brand or competitors, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.aiResponsesEntities({});

Input

Name	Type	Required	Description
`select`	`string[]`	Yes	A list of fields to return.
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`competitors`	`object[]`	No	A list of competitor names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`limit`	`number`	No	The number of results to return.
`date`	`string`	No	The date to search for in YYYY-MM-DD format.
`date_compared`	`string`	No	A date to compare date with, in YYYY-MM-DD format.
`order_by`	`relevance \| volume \| object`	No	How to order the results: a column, or how the responses talk about one brand, as the Sentiment page in Brand Radar can.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`brand_filter`	`Record<string, any>`	No	A filter expression for your brand’s visibility, mirroring the “Your brand” filter.
`volume_range`	`object`	No	The volume range to filter by.
`changes`	`object`	No	Requires date_compared.
`sentiment_filter`	`Record<string, any>`	No	A filter on how the responses talk about your brands and competitors, like the Sentiment filter in Brand Radar.
`opinions_first`	`boolean`	No	Puts the responses with a positive, negative or mixed mention of a tracked brand before the others, each group by relevance, as the Sentiment page in Brand Rada
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

competitors full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

order_by full type

relevance | volume | {
  direction: most_negative | most_positive,
  brand: string,
  aspect?: features_specs | performance_effectiveness | price_value | reputation_popularity | quality_reliability | design_comfort | usability_compatibility | availability_delivery | safety_health | service_support | general
}

volume_range full type

{
  from?: number,
  to?: number
}

changes full type

{
  prompt?: (new | lost | no_change)[],
  mentions?: (new | lost | no_change)[],
  citations?: (new | lost | no_change)[]
}

Output

Name	Type	Required	Description
`ai_responses`	`object[]`	Yes	—

ai_responses full type

{
  brand_sentiment?: any[] | null,
  country?: string | null,
  data_source?: string | null,
  funnel_stage?: string | null,
  intent?: string[] | null,
  last_updated?: string | null,
  links?: any[] | null,
  question?: string | null,
  response?: string | null,
  search_queries?: string[] | null,
  status?: string | null,
  tags?: string[] | null,
  volume?: number | null
}[]

citationsHistoryEntities

brandRadar.citationsHistoryEntities Brand Radar: get citation counts over time, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.citationsHistoryEntities({});

Input

Name	Type	Required	Description
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  citations?: number | null,
  date?: string | null
}[]

citationsOverviewEntities

brandRadar.citationsOverviewEntities Brand Radar: get citation counts per brand, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.citationsOverviewEntities({});

Input

Name	Type	Required	Description
`select`	`string[]`	Yes	A list of fields to return.
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`competitors`	`object[]`	No	A list of competitor names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

competitors full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  brand?: string | null,
  entity_type?: string | null,
  no_tracked_brands?: number | null,
  only_competitors_brands?: number | null,
  only_target_brand?: number | null,
  target_and_competitors_brands?: number | null,
  total?: number | null
}[]

citedDomains

brandRadar.citedDomains Brand Radar: get domains AI assistants cite in answers about the brand Risk: read

await corsair.ahrefs.api.brandRadar.citedDomains({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of fields to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brand`	`string`	No	A comma-separated list of brands to search for.
`competitors`	`string`	No	A comma-separated list of competitors of your brands.
`data_source`	`string`	Yes	Comma-separated chatbot models: chatgpt, google_ai_overviews, google_ai_mode, gemini, perplexity, copilot, claude (custom prompts only), grok, google_ai_overviews_keywords, google_ai_mode_keywords.
`country`	`string`	No	A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`limit`	`number`	No	The number of results to return.
`date`	`string`	No	The date to search for in YYYY-MM-DD format.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`domains`	`object[]`	Yes	—

domains full type

{
  domain?: string | null,
  mentions?: any[] | null,
  pages?: number | null,
  responses?: number | null,
  volume?: number | null
}[]

citedDomainsEntities

brandRadar.citedDomainsEntities Brand Radar: get domains AI assistants cite in answers about the brand, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.citedDomainsEntities({});

Input

Name	Type	Required	Description
`select`	`string[]`	Yes	A list of fields to return.
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`competitors`	`object[]`	No	A list of competitor names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`limit`	`number`	No	The number of results to return.
`date`	`string`	No	The date to search for in YYYY-MM-DD format.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`brand_filter`	`Record<string, any>`	No	A filter expression for your brand’s visibility, mirroring the “Your brand” filter.
`volume_range`	`object`	No	The volume range to filter by.
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

competitors full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

volume_range full type

{
  from?: number,
  to?: number
}

Output

Name	Type	Required	Description
`domains`	`object[]`	Yes	—

domains full type

{
  domain?: string | null,
  mentions?: any[] | null,
  pages?: number | null,
  responses?: number | null,
  volume?: number | null
}[]

citedPages

brandRadar.citedPages Brand Radar: get pages AI assistants cite in answers about the brand Risk: read

await corsair.ahrefs.api.brandRadar.citedPages({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of fields to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brand`	`string`	No	A comma-separated list of brands to search for.
`competitors`	`string`	No	A comma-separated list of competitors of your brands.
`data_source`	`string`	Yes	Comma-separated chatbot models: chatgpt, google_ai_overviews, google_ai_mode, gemini, perplexity, copilot, claude (custom prompts only), grok, google_ai_overviews_keywords, google_ai_mode_keywords.
`country`	`string`	No	A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`limit`	`number`	No	The number of results to return.
`date`	`string`	No	The date to search for in YYYY-MM-DD format.
`tracked_urls`	`string`	No	A comma-separated list of tracked page URLs.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  mentions?: any[] | null,
  responses?: number | null,
  title?: string | null,
  url?: string | null,
  volume?: number | null
}[]

citedPagesEntities

brandRadar.citedPagesEntities Brand Radar: get pages AI assistants cite in answers about the brand, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.citedPagesEntities({});

Input

Name	Type	Required	Description
`select`	`string[]`	Yes	A list of fields to return.
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`competitors`	`object[]`	No	A list of competitor names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`limit`	`number`	No	The number of results to return.
`date`	`string`	No	The date to search for in YYYY-MM-DD format.
`tracked_urls`	`string[]`	No	A list of tracked page URLs.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`brand_filter`	`Record<string, any>`	No	A filter expression for your brand’s visibility, mirroring the “Your brand” filter.
`volume_range`	`object`	No	The volume range to filter by.
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

competitors full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

volume_range full type

{
  from?: number,
  to?: number
}

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  mentions?: any[] | null,
  responses?: number | null,
  title?: string | null,
  url?: string | null,
  volume?: number | null
}[]

impressionsHistory

brandRadar.impressionsHistory Brand Radar: get AI answer impressions over time Risk: read

await corsair.ahrefs.api.brandRadar.impressionsHistory({});

Input

Name	Type	Required	Description
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brand`	`string`	Yes	The brand to search for.
`data_source`	`string`	Yes	Comma-separated chatbot models: chatgpt, google_ai_overviews, google_ai_mode, gemini, perplexity, copilot, claude (custom prompts only), grok, google_ai_overviews_keywords, google_ai_mode_keywords.
`country`	`string`	No	A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  impressions?: number | null
}[]

impressionsHistoryEntities

brandRadar.impressionsHistoryEntities Brand Radar: get AI answer impressions over time, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.impressionsHistoryEntities({});

Input

Name	Type	Required	Description
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  impressions?: number | null
}[]

impressionsOverview

brandRadar.impressionsOverview Brand Radar: get AI answer impressions per brand Risk: read

await corsair.ahrefs.api.brandRadar.impressionsOverview({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of fields to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brand`	`string`	No	A comma-separated list of brands to search for.
`competitors`	`string`	No	A comma-separated list of competitors of your brands.
`data_source`	`string`	Yes	Comma-separated chatbot models: chatgpt, google_ai_overviews, google_ai_mode, gemini, perplexity, copilot, claude (custom prompts only), grok, google_ai_overviews_keywords, google_ai_mode_keywords.
`country`	`string`	No	A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  brand?: string | null,
  entity_type?: string | null,
  no_tracked_brands?: number | null,
  only_competitors_brands?: number | null,
  only_target_brand?: number | null,
  target_and_competitors_brands?: number | null,
  total?: number | null
}[]

impressionsOverviewEntities

brandRadar.impressionsOverviewEntities Brand Radar: get AI answer impressions per brand, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.impressionsOverviewEntities({});

Input

Name	Type	Required	Description
`select`	`string[]`	Yes	A list of fields to return.
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`competitors`	`object[]`	No	A list of competitor names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

competitors full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  brand?: string | null,
  entity_type?: string | null,
  no_tracked_brands?: number | null,
  only_competitors_brands?: number | null,
  only_target_brand?: number | null,
  target_and_competitors_brands?: number | null,
  total?: number | null
}[]

mentionsHistory

brandRadar.mentionsHistory Brand Radar: get brand mentions in AI answers over time Risk: read

await corsair.ahrefs.api.brandRadar.mentionsHistory({});

Input

Name	Type	Required	Description
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brand`	`string`	Yes	The brand to search for.
`data_source`	`string`	Yes	Comma-separated chatbot models: chatgpt, google_ai_overviews, google_ai_mode, gemini, perplexity, copilot, claude (custom prompts only), grok, google_ai_overviews_keywords, google_ai_mode_keywords.
`country`	`string`	No	A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  mentions?: number | null
}[]

mentionsHistoryEntities

brandRadar.mentionsHistoryEntities Brand Radar: get brand mentions in AI answers over time, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.mentionsHistoryEntities({});

Input

Name	Type	Required	Description
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  mentions?: number | null
}[]

mentionsOverview

brandRadar.mentionsOverview Brand Radar: get brand mentions in AI answers per brand Risk: read

await corsair.ahrefs.api.brandRadar.mentionsOverview({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of fields to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brand`	`string`	No	A comma-separated list of brands to search for.
`competitors`	`string`	No	A comma-separated list of competitors of your brands.
`data_source`	`string`	Yes	Comma-separated chatbot models: chatgpt, google_ai_overviews, google_ai_mode, gemini, perplexity, copilot, claude (custom prompts only), grok, google_ai_overviews_keywords, google_ai_mode_keywords.
`country`	`string`	No	A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  brand?: string | null,
  entity_type?: string | null,
  no_tracked_brands?: number | null,
  only_competitors_brands?: number | null,
  only_target_brand?: number | null,
  target_and_competitors_brands?: number | null,
  total?: number | null
}[]

mentionsOverviewEntities

brandRadar.mentionsOverviewEntities Brand Radar: get brand mentions in AI answers per brand, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.mentionsOverviewEntities({});

Input

Name	Type	Required	Description
`select`	`string[]`	Yes	A list of fields to return.
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`competitors`	`object[]`	No	A list of competitor names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

competitors full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  brand?: string | null,
  entity_type?: string | null,
  no_tracked_brands?: number | null,
  only_competitors_brands?: number | null,
  only_target_brand?: number | null,
  target_and_competitors_brands?: number | null,
  total?: number | null
}[]

sovHistory

brandRadar.sovHistory Brand Radar: get AI share of voice over time Risk: read

await corsair.ahrefs.api.brandRadar.sovHistory({});

Input

Name	Type	Required	Description
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brand`	`string`	No	A comma-separated list of brands to search for.
`competitors`	`string`	No	A comma-separated list of competitors of your brands.
`data_source`	`string`	Yes	Comma-separated chatbot models: chatgpt, google_ai_overviews, google_ai_mode, gemini, perplexity, copilot, claude (custom prompts only), grok, google_ai_overviews_keywords, google_ai_mode_keywords.
`country`	`string`	No	A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  share_of_voice?: any[] | null
}[]

sovHistoryEntities

brandRadar.sovHistoryEntities Brand Radar: get AI share of voice over time, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.sovHistoryEntities({});

Input

Name	Type	Required	Description
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`competitors`	`object[]`	No	A list of competitor names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

competitors full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  share_of_voice?: any[] | null
}[]

sovOverview

brandRadar.sovOverview Brand Radar: get AI share of voice per brand Risk: read

await corsair.ahrefs.api.brandRadar.sovOverview({});

Input

Name	Type	Required	Description
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brand`	`string`	No	A comma-separated list of brands to search for.
`competitors`	`string`	No	A comma-separated list of competitors of your brands.
`data_source`	`string`	Yes	Comma-separated chatbot models: chatgpt, google_ai_overviews, google_ai_mode, gemini, perplexity, copilot, claude (custom prompts only), grok, google_ai_overviews_keywords, google_ai_mode_keywords.
`country`	`string`	No	A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  brand?: string | null,
  entity_type?: string | null,
  share_of_voice?: number | null
}[]

sovOverviewEntities

brandRadar.sovOverviewEntities Brand Radar: get AI share of voice per brand, with brands and competitors given as names or URL groups Risk: read

await corsair.ahrefs.api.brandRadar.sovOverviewEntities({});

Input

Name	Type	Required	Description
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`report_id`	`string`	No	The ID of the report to use.
`brands`	`object[]`	No	A list of brand names and websites to search for.
`competitors`	`object[]`	No	A list of competitor names and websites to search for.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`data_source`	`(chatgpt \| google_ai_overviews \| google_ai_mode \| gemini \| perplexity \| copilot \| claude \| grok \| google_ai_overviews_keywords \| google_ai_mode_keywords)[]`	Yes	A list of chatbot models.
`country`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).
`prompts`	`ahrefs \| custom`	No	The type of prompts to use.
`tags_filter`	`Record<string, any>`	No	A filter expression for prompt tags.
`output`	`json`	No	—

brands full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

competitors full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  brand?: string | null,
  entity_type?: string | null,
  share_of_voice?: number | null
}[]

Content Helper

topics

contentHelper.topics Get the topics top-ranking pages cover for a keyword, with coverage scores Risk: read

await corsair.ahrefs.api.contentHelper.topics({});

Input

Name	Type	Required	Description
`keyword`	`string`	Yes	The keyword to analyse the SERP for.
`country`	`string`	Yes	A two-letter country code (ISO 3166-1 alpha-2).
`top_competitors`	`number`	No	How many of the top-ranking pages to analyse.
`target_url`	`string`	No	(500 units) A page of your own to score against the same topics, for example a draft you are writing or a page you want to improve.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`topics`	`object[]`	Yes	—

topics full type

{
  avg_score?: number | null,
  description?: string | null,
  pages?: any[] | null,
  pages_covering?: number | null,
  serp_date?: string | null,
  target?: Record<string, any> | null,
  topic?: string | null
}[]

Gsc

anonymousQueries

gsc.anonymousQueries Estimate the queries Search Console hides as anonymous for a project Risk: read

await corsair.ahrefs.api.gsc.anonymousQueries({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A comma-separated list of columns to order results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`project_id`	`number`	Yes	Project ID
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`country`	`string`	Yes	A two-letter country code (ISO 3166-1 alpha-2).
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  cpc?: number | null,
  keyword?: string | null,
  keyword_country?: string | null,
  keyword_difficulty?: number | null,
  position?: number | null,
  position_kind?: string | null,
  traffic?: number | null,
  url?: string | null,
  volume?: number | null
}[]

ctrByPosition

gsc.ctrByPosition Get average Search Console CTR for each ranking position Risk: read

await corsair.ahrefs.api.gsc.ctrByPosition({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`device`	`desktop \| mobile \| tablet`	No	Filter by device type (DESKTOP, MOBILE, TABLET).
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  average_ctr_percent?: number | null,
  keyword_count?: number | null,
  position?: number | null
}[]

keywordHistory

gsc.keywordHistory Get Search Console history for specific queries Risk: read

await corsair.ahrefs.api.gsc.keywordHistory({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`device`	`desktop \| mobile \| tablet`	No	Filter by device type (DESKTOP, MOBILE, TABLET).
`keywords`	`string`	No	A comma-separated list of keywords to get history data for.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  clicks?: number | null,
  ctr?: number | null,
  date?: string | null,
  impressions?: number | null,
  keyword?: string | null,
  position?: number | null
}[]

keywords

gsc.keywords List Search Console queries for a project with clicks, impressions, CTR and average position Risk: read

await corsair.ahrefs.api.gsc.keywords({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`search_type`	`web \| image \| video \| news`	No	The type of search results to return (web, image, video, news).
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`device`	`desktop \| mobile \| tablet`	No	Filter by device type (DESKTOP, MOBILE, TABLET).
`limit`	`number`	No	The number of results to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`keyword_list_id`	`number`	No	The id of an existing keyword list to show metrics for.
`keyword_lists`	`string`	No	Keyword lists filter (JSON string).
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  clicks?: number | null,
  ctr?: number | null,
  impressions?: number | null,
  keyword?: string | null,
  keyword_list_labels?: string[] | null,
  position?: number | null,
  top_url?: string | null,
  urls_count?: number | null
}[]

metricsByCountry

gsc.metricsByCountry Get Search Console clicks by country Risk: read

await corsair.ahrefs.api.gsc.metricsByCountry({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`search_type`	`web \| image \| video \| news`	No	The type of search results to return (web, image, video, news).
`device`	`desktop \| mobile \| tablet`	No	Filter by device type (DESKTOP, MOBILE, TABLET).
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  clicks?: number | null,
  country?: string | null
}[]

pageHistory

gsc.pageHistory Get Search Console history for specific pages Risk: read

await corsair.ahrefs.api.gsc.pageHistory({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`device`	`desktop \| mobile \| tablet`	No	Filter by device type (DESKTOP, MOBILE, TABLET).
`pages`	`string`	No	A comma-separated list of page URLs to get history data for.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  clicks?: number | null,
  ctr?: number | null,
  date?: string | null,
  impressions?: number | null,
  page?: string | null,
  position?: number | null
}[]

pages

gsc.pages List Search Console pages for a project with clicks, impressions, CTR and average position Risk: read

await corsair.ahrefs.api.gsc.pages({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`search_type`	`web \| image \| video \| news`	No	The type of search results to return (web, image, video, news).
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`device`	`desktop \| mobile \| tablet`	No	Filter by device type (DESKTOP, MOBILE, TABLET).
`limit`	`number`	No	The number of results to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  clicks?: number | null,
  ctr?: number | null,
  impressions?: number | null,
  keywords_count?: number | null,
  page?: string | null,
  position?: number | null,
  top_keyword?: string | null,
  traffic_value?: number | null
}[]

pagesHistory

gsc.pagesHistory Get the number of pages with Search Console impressions over time Risk: read

await corsair.ahrefs.api.gsc.pagesHistory({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`search_type`	`web \| image \| video \| news`	No	The type of search results to return (web, image, video, news).
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`device`	`desktop \| mobile \| tablet`	No	Filter by device type (DESKTOP, MOBILE, TABLET).
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  total_pages?: number | null
}[]

performanceByDevice

gsc.performanceByDevice Get Search Console performance split by device Risk: read

await corsair.ahrefs.api.gsc.performanceByDevice({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`search_type`	`web \| image \| video \| news`	No	The type of search results to return (web, image, video, news).
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  clicks?: number | null,
  ctr?: number | null,
  device?: string | null,
  impressions?: number | null,
  position?: number | null
}[]

performanceByPosition

gsc.performanceByPosition Get Search Console clicks and impressions split by position range Risk: read

await corsair.ahrefs.api.gsc.performanceByPosition({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`search_type`	`web \| image \| video \| news`	No	The type of search results to return (web, image, video, news).
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`device`	`desktop \| mobile \| tablet`	No	Filter by device type (DESKTOP, MOBILE, TABLET).
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  clicks?: number | null,
  clicks_percent?: number | null,
  impressions?: number | null,
  impressions_percent?: number | null,
  keyword_count?: number | null,
  keyword_count_percent?: number | null,
  position_range?: string | null
}[]

performanceHistory

gsc.performanceHistory Get Search Console clicks, impressions, CTR and position over time Risk: read

await corsair.ahrefs.api.gsc.performanceHistory({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`search_type`	`web \| image \| video \| news`	No	The type of search results to return (web, image, video, news).
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`device`	`desktop \| mobile \| tablet`	No	Filter by device type (DESKTOP, MOBILE, TABLET).
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  clicks?: number | null,
  ctr?: number | null,
  date?: string | null,
  impressions?: number | null,
  position?: number | null
}[]

positionsHistory

gsc.positionsHistory Get how many queries rank in each position bucket over time in Search Console Risk: read

await corsair.ahrefs.api.gsc.positionsHistory({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	Project ID.
`portfolio_id`	`number`	No	Portfolio ID.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`search_type`	`web \| image \| video \| news`	No	The type of search results to return (web, image, video, news).
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`device`	`desktop \| mobile \| tablet`	No	Filter by device type (DESKTOP, MOBILE, TABLET).
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  position_1_to_3?: number | null,
  position_4_to_10?: number | null,
  position_11_to_20?: number | null,
  position_21_to_50?: number | null,
  position_51_plus?: number | null,
  total?: number | null
}[]

Keywords Explorer

matchingTerms

keywordsExplorer.matchingTerms Find keyword ideas that contain the seed keywords Risk: read

await corsair.ahrefs.api.keywordsExplorer.matchingTerms({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A column to order results by.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`keyword_list_id`	`number`	No	The id of an existing keyword list.
`keywords`	`string`	No	A comma-separated list of keywords to show metrics for.
`country`	`string \| all`	Yes	A country code, or all for matching terms across all locations.
`terms`	`all \| questions \| global`	No	All keyword ideas (all), questions (questions), or global terms including translations (global).
`match_mode`	`terms \| phrase`	No	Keyword ideas contain the words from your query in any order (terms) or in the exact order they are written (phrase).
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  country?: string | null,
  cpc?: number | null,
  cps?: number | null,
  difficulty?: number | null,
  first_seen?: string | null,
  global_traffic_potential?: number | null,
  global_volume?: number | null,
  intents?: Record<string, any> | null,
  keyword?: string | null,
  parent_topic?: string | null,
  serp_features?: string[] | null,
  serp_last_update?: string | null,
  traffic_potential?: number | null,
  volume?: number | null,
  volume_desktop_pct?: number | null,
  volume_mobile_pct?: number | null,
  volume_monthly?: number | null
}[]

overview

keywordsExplorer.overview Get keyword metrics such as volume, difficulty, CPC, clicks, and traffic potential Risk: read

await corsair.ahrefs.api.keywordsExplorer.overview({});

Input

Name	Type	Required	Description
`timeout`	`number`	No	—
`limit`	`number`	No	Defaults to 1000.
`order_by`	`string`	No	—
`where`	`string`	No	—
`select`	`string`	Yes	—
`volume_monthly_date_to`	`string`	No	—
`volume_monthly_date_from`	`string`	No	—
`target_mode`	`exact \| prefix \| domain \| subdomains`	No	—
`target`	`string`	No	—
`target_position`	`in_top10 \| in_top100`	No	—
`country`	`string \| all`	Yes	—
`keywords`	`string \| string[]`	No	—
`keyword_list_id`	`number`	No	—
`output`	`json`	No	Defaults to “json”.

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  clicks?: number | null,
  cpc?: number | null,
  cps?: number | null,
  difficulty?: number | null,
  first_seen?: string | null,
  global_volume?: number | null,
  intents?: {
    informational?: boolean,
    navigational?: boolean,
    commercial?: boolean,
    transactional?: boolean,
    branded?: boolean,
    local?: boolean
  } | null,
  keyword: string,
  parent_topic?: string | null,
  parent_volume?: number | null,
  searches_pct_clicks_organic_and_paid?: number | null,
  searches_pct_clicks_organic_only?: number | null,
  searches_pct_clicks_paid_only?: number | null,
  serp_features?: string[],
  serp_last_update?: string | null,
  traffic_potential?: number | null,
  volume?: number | null,
  volume_desktop_pct?: number | null,
  volume_mobile_pct?: number | null,
  volume_monthly?: number | null,
  volume_monthly_history?: Record<string, any>[]
}[]

relatedTerms

keywordsExplorer.relatedTerms Find related keyword ideas that top pages also rank for or talk about Risk: read

await corsair.ahrefs.api.keywordsExplorer.relatedTerms({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A column to order results by.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`keyword_list_id`	`number`	No	The id of an existing keyword list.
`keywords`	`string`	No	A comma-separated list of keywords to show metrics for.
`country`	`string`	Yes	A two-letter country code (ISO 3166-1 alpha-2).
`terms`	`all \| also_rank_for \| also_talk_about`	No	Related keywords which top-ranking pages also rank for (also_rank_for), additional keywords frequently mentioned in top-ranking pages (also_talk_about), or comb
`view_for`	`top_10 \| top_100`	No	View keywords for the top 10 or top 100 ranking pages.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  country?: string | null,
  cpc?: number | null,
  cps?: number | null,
  difficulty?: number | null,
  first_seen?: string | null,
  global_traffic_potential?: number | null,
  global_volume?: number | null,
  intents?: Record<string, any> | null,
  keyword?: string | null,
  parent_topic?: string | null,
  serp_features?: string[] | null,
  serp_last_update?: string | null,
  traffic_potential?: number | null,
  volume?: number | null,
  volume_desktop_pct?: number | null,
  volume_mobile_pct?: number | null,
  volume_monthly?: number | null
}[]

searchSuggestions

keywordsExplorer.searchSuggestions Get search autocomplete suggestions for seed keywords Risk: read

await corsair.ahrefs.api.keywordsExplorer.searchSuggestions({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A column to order results by.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`keyword_list_id`	`number`	No	The id of an existing keyword list.
`keywords`	`string`	No	A comma-separated list of keywords to show metrics for.
`country`	`string`	Yes	A two-letter country code (ISO 3166-1 alpha-2).
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  country?: string | null,
  cpc?: number | null,
  cps?: number | null,
  difficulty?: number | null,
  first_seen?: string | null,
  global_traffic_potential?: number | null,
  global_volume?: number | null,
  intents?: Record<string, any> | null,
  keyword?: string | null,
  parent_topic?: string | null,
  serp_features?: string[] | null,
  serp_last_update?: string | null,
  traffic_potential?: number | null,
  volume?: number | null,
  volume_desktop_pct?: number | null,
  volume_mobile_pct?: number | null,
  volume_monthly?: number | null
}[]

volumeByCountry

keywordsExplorer.volumeByCountry Get search volume for keywords in each country Risk: read

await corsair.ahrefs.api.keywordsExplorer.volumeByCountry({});

Input

Name	Type	Required	Description
`select`	`string`	No	A comma-separated list of fields to return.
`order_by`	`string`	No	A field to order the results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`offset`	`number`	No	The number of results to skip.
`keyword_list_id`	`number`	No	The id of an existing keyword list.
`keyword`	`string`	No	A comma-separated list of keywords to show metrics for.
`countries`	`string`	No	A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).
`volume_monthly_date_from`	`string`	No	The start date in YYYY-MM-DD format for retrieving historical monthly search volumes in the volume_monthly_history field.
`volume_monthly_date_to`	`string`	No	The end date in YYYY-MM-DD format for retrieving historical monthly search volumes in the volume_monthly_history field.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`countries`	`object[]`	Yes	—

countries full type

{
  country?: string | null,
  cpc?: number | null,
  difficulty?: number | null,
  growth_rate_12m?: number | null,
  has_serp?: boolean | null,
  top_keyword?: string | null,
  top_page?: string | null,
  top_page_title?: string | null,
  traffic_potential?: number | null,
  volume?: number | null,
  volume_monthly_history?: any[] | null
}[]

volumeHistory

keywordsExplorer.volumeHistory Get monthly search volume history for a keyword Risk: read

await corsair.ahrefs.api.keywordsExplorer.volumeHistory({});

Input

Name	Type	Required	Description
`keyword`	`string`	Yes	The keyword to show metrics for.
`country`	`string \| all`	Yes	A country code, or all for all locations.
`date_from`	`string`	No	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  volume?: number | null
}[]

Management

addBrandRadarPrompts

management.addBrandRadarPrompts Add custom prompts to a Brand Radar report Risk: write

await corsair.ahrefs.api.management.addBrandRadarPrompts({});

Input

Name	Type	Required	Description
`report_id`	`string`	Yes	The ID of the report to use.
`output`	`json`	No	—
`prompts`	`string[]`	Yes	A list of custom prompts to add.
`countries`	`string[]`	Yes	A list of two-letter country codes (ISO 3166-1 alpha-2).
`tags`	`string[]`	No	A list of tags to assign to the prompts.

Output

Name	Type	Required	Description
`prompts`	`object[]`	Yes	—

prompts full type

{
  country?: string | null,
  created_at?: string | null,
  prompt?: string | null,
  tags?: string[] | null
}[]

addKeywordListKeywords

management.addKeywordListKeywords Add keywords to a keyword list Risk: write

await corsair.ahrefs.api.management.addKeywordListKeywords({});

Input

Name	Type	Required	Description
`keyword_list_id`	`number`	Yes	The id of an existing keyword list.
`output`	`json`	No	—
`keywords`	`string[]`	Yes	A list of keywords to add.

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  keyword?: string | null
}[]

addProjectCompetitors

management.addProjectCompetitors Add competitors to a Rank Tracker project Risk: write

await corsair.ahrefs.api.management.addProjectCompetitors({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The unique identifier of the project.
`output`	`json`	No	—
`competitors`	`object[]`	Yes	A list of competitors to add.

competitors full type

{
  url: string,
  mode: exact | prefix | domain | subdomains
}[]

Output

Name	Type	Required	Description
`competitors`	`object[]`	Yes	—

competitors full type

{
  mode?: string | null,
  url?: string | null
}[]

addProjectKeywords

management.addProjectKeywords Add tracked keywords to a Rank Tracker project Risk: write

await corsair.ahrefs.api.management.addProjectKeywords({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The unique identifier of the project.
`output`	`json`	No	—
`keywords`	`object[]`	Yes	A list of keywords to add.
`locations`	`object[]`	Yes	A list of locations to assign to given keywords.

keywords full type

{
  keyword: string,
  tags?: string[]
}[]

locations full type

{
  country: string,
  location_id?: number,
  language?: string
}[]

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  keyword?: string | null,
  language?: string | null,
  language_code?: string | null,
  location?: string | null,
  location_id?: number | null,
  tags?: string[] | null
}[]

addProjectKeywordTags

management.addProjectKeywordTags Add or replace tags on tracked keywords Risk: write

await corsair.ahrefs.api.management.addProjectKeywordTags({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The unique identifier of the project.
`keywords`	`object[]`	Yes	A list of keywords to add.
`tags`	`string[]`	Yes	A list of tags to add to the keywords.
`update_mode`	`add \| replace`	No	add appends tags to existing ones; replace overwrites all existing tags entirely.
`output`	`json`	No	—

keywords full type

{
  keyword: string,
  country?: string,
  location_id?: number,
  language?: string
}[]

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  keyword?: string | null,
  language?: string | null,
  language_code?: string | null,
  location?: string | null,
  location_id?: number | null,
  tags?: string[] | null
}[]

brandRadarPrompts

management.brandRadarPrompts List custom prompts of a Brand Radar report Risk: read

await corsair.ahrefs.api.management.brandRadarPrompts({});

Input

Name	Type	Required	Description
`report_id`	`string`	Yes	The ID of the report to use.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`prompts`	`object[]`	Yes	—

prompts full type

{
  country?: string | null,
  created_at?: string | null,
  prompt?: string | null,
  tags?: string[] | null
}[]

brandRadarReports

management.brandRadarReports List Brand Radar reports Risk: read

await corsair.ahrefs.api.management.brandRadarReports({});

Input

Name	Type	Required	Description
`output`	`json`	No	—

Output

Name	Type	Required	Description
`reports`	`object[]`	Yes	—

reports full type

{
  created_at?: string | null,
  project_id?: number | null,
  prompts_frequency?: any[] | null,
  report_id?: string | null,
  report_name?: string | null,
  settings?: Record<string, any> | null,
  updated_at?: string | null
}[]

createBrandRadarReport

management.createBrandRadarReport Create a Brand Radar report for a brand and its competitors Risk: write

await corsair.ahrefs.api.management.createBrandRadarReport({});

Input

Name	Type	Required	Description
`output`	`json`	No	—
`brand`	`object[] \| string[]`	No	At least one of brand or competitors is required to be non-empty.
`competitors`	`object[] \| string[]`	No	At least one of brand or competitors is required to be non-empty.
`name`	`string`	No	The name of the report.
`project_id`	`number`	No	The ID of the project to use.
`country`	`string[]`	No	Saved countries.
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`content_filter`	`object`	No	Optional phrases used to include or exclude results based on their content.
`prompts_frequency`	`object[]`	No	The prompts frequency to use.

brand full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[] | string[]

competitors full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[] | string[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

prompts_frequency full type

{
  data_source: chatgpt | google_ai_overviews | google_ai_mode | gemini | perplexity | copilot | claude | grok,
  frequency: daily | weekly | monthly | off
}[]

Output

Name	Type	Required	Description
`reports`	`object[]`	Yes	—

reports full type

{
  created_at?: string | null,
  project_id?: number | null,
  prompts_frequency?: any[] | null,
  report_id?: string | null,
  report_name?: string | null,
  settings?: Record<string, any> | null,
  updated_at?: string | null
}[]

createKeywordList

management.createKeywordList Create a Keywords Explorer keyword list Risk: write

await corsair.ahrefs.api.management.createKeywordList({});

Input

Name	Type	Required	Description
`output`	`json`	No	—
`name`	`string`	Yes	The name of the keyword list.
`location`	`string`	Yes	The location of the keyword list.
`countries`	`string[]`	No	Up to 15 country codes to select when location is ‘all’.
`keywords`	`string[]`	No	Initial keywords to add.
`access`	`private \| shared`	No	The access type of the keyword list.
`owned_by`	`string`	No	The email of the keyword list owner.
`folder_id`	`number`	No	The ID of the folder to assign the keyword list to.

Output

Name	Type	Required	Description
`keyword_list`	`object`	Yes	—

keyword_list full type

{
  access?: string | null,
  countries?: string[] | null,
  folder_id?: string | null,
  keyword_count?: number | null,
  keyword_list_id?: string | null,
  location?: string | null,
  name?: string | null,
  owned_by?: string | null
}

createProject

management.createProject Create an Ahrefs project for a target Risk: write

await corsair.ahrefs.api.management.createProject({});

Input

Name	Type	Required	Description
`output`	`json`	No	—
`access`	`private \| shared`	No	The access type of the project.
`owned_by`	`string`	No	The email of the project owner.
`project_name`	`string`	Yes	The name of the project.
`mode`	`exact \| prefix \| domain \| subdomains`	Yes	The scope of the target.
`url`	`string`	Yes	The URL of your target.
`protocol`	`both \| http \| https`	Yes	The protocol of your target.
`folder_id`	`number`	No	The folder id to assign to the project.

Output

Name	Type	Required	Description
`projects`	`object[]`	Yes	—

projects full type

{
  access?: string | null,
  folder?: Record<string, any> | null,
  keyword_count?: number | null,
  mode?: string | null,
  owned_by?: string | null,
  project_id?: string | null,
  project_name?: string | null,
  protocol?: string | null,
  url?: string | null,
  verified?: boolean | null,
  web_analytics_data_key?: string | null
}[]

deleteBrandRadarPrompts

management.deleteBrandRadarPrompts Remove custom prompts from a Brand Radar report Risk: destructive

await corsair.ahrefs.api.management.deleteBrandRadarPrompts({});

Input

Name	Type	Required	Description
`report_id`	`string`	Yes	The ID of the report to use.
`output`	`json`	No	—
`prompts`	`string[]`	Yes	A list of custom prompts to delete.
`countries`	`string[]`	No	A list of two-letter country codes (ISO 3166-1 alpha-2).

Output

Name	Type	Required	Description
`prompts`	`object[]`	Yes	—

prompts full type

{
  country?: string | null,
  created_at?: string | null,
  prompt?: string | null,
  tags?: string[] | null
}[]

deleteKeywordListKeywords

management.deleteKeywordListKeywords Remove keywords from a keyword list Risk: destructive

await corsair.ahrefs.api.management.deleteKeywordListKeywords({});

Input

Name	Type	Required	Description
`keyword_list_id`	`number`	Yes	The id of an existing keyword list.
`output`	`json`	No	—
`keywords`	`string[]`	Yes	A list of keywords to delete.

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  keyword?: string | null
}[]

deleteKeywordLists

management.deleteKeywordLists Delete Keywords Explorer keyword lists Risk: destructive

await corsair.ahrefs.api.management.deleteKeywordLists({});

Input

Name	Type	Required	Description
`keyword_list_ids`	`string`	Yes	A comma-separated list of the IDs of the keyword lists to delete.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keyword_lists`	`object[]`	Yes	—

keyword_lists full type

{
  access?: string | null,
  countries?: string[] | null,
  folder_id?: string | null,
  keyword_count?: number | null,
  keyword_list_id?: string | null,
  location?: string | null,
  name?: string | null,
  owned_by?: string | null
}[]

deleteProjectCompetitors

management.deleteProjectCompetitors Remove competitors from a Rank Tracker project Risk: destructive

await corsair.ahrefs.api.management.deleteProjectCompetitors({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The unique identifier of the project.
`output`	`json`	No	—
`competitors`	`object[]`	Yes	A list of competitors to delete.

competitors full type

{
  url: string,
  mode: exact | prefix | domain | subdomains
}[]

Output

Name	Type	Required	Description
`competitors`	`object[]`	Yes	—

competitors full type

{
  mode?: string | null,
  url?: string | null
}[]

deleteProjectKeywords

management.deleteProjectKeywords Remove tracked keywords from a Rank Tracker project Risk: destructive

await corsair.ahrefs.api.management.deleteProjectKeywords({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The unique identifier of the project.
`output`	`json`	No	—
`keywords`	`object[]`	Yes	A list of keywords to delete.

keywords full type

{
  keyword: string,
  country?: string,
  location_id?: number,
  language?: string
}[]

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  keyword?: string | null,
  language?: string | null,
  language_code?: string | null,
  location?: string | null,
  location_id?: number | null,
  tags?: string[] | null
}[]

deleteProjectKeywordTags

management.deleteProjectKeywordTags Remove tags from tracked keywords Risk: destructive

await corsair.ahrefs.api.management.deleteProjectKeywordTags({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The unique identifier of the project.
`keywords`	`object[]`	Yes	A list of keywords to delete.
`tags`	`string[]`	Yes	A list of tags to remove from the keywords.
`output`	`json`	No	—

keywords full type

{
  keyword: string,
  country?: string,
  location_id?: number,
  language?: string
}[]

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  keyword?: string | null,
  language?: string | null,
  language_code?: string | null,
  location?: string | null,
  location_id?: number | null,
  tags?: string[] | null
}[]

deleteProjects

management.deleteProjects Delete Ahrefs projects Risk: destructive

await corsair.ahrefs.api.management.deleteProjects({});

Input

Name	Type	Required	Description
`project_ids`	`string`	Yes	A comma-separated list of the IDs of the projects you want to delete.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`projects`	`object[]`	Yes	—

projects full type

{
  access?: string | null,
  folder?: Record<string, any> | null,
  keyword_count?: number | null,
  mode?: string | null,
  owned_by?: string | null,
  project_id?: string | null,
  project_name?: string | null,
  protocol?: string | null,
  url?: string | null,
  verified?: boolean | null,
  web_analytics_data_key?: string | null
}[]

keywordListKeywords

management.keywordListKeywords List keywords in a saved keyword list Risk: read

await corsair.ahrefs.api.management.keywordListKeywords({});

Input

Name	Type	Required	Description
`keyword_list_id`	`number`	Yes	The id of an existing keyword list.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  keyword?: string | null
}[]

keywordLists

management.keywordLists List saved Keywords Explorer keyword lists Risk: read

await corsair.ahrefs.api.management.keywordLists({});

Input

Name	Type	Required	Description
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keyword_lists`	`object[]`	Yes	—

keyword_lists full type

{
  access?: string | null,
  countries?: string[] | null,
  folder_id?: string | null,
  keyword_count?: number | null,
  keyword_list_id?: string | null,
  location?: string | null,
  name?: string | null,
  owned_by?: string | null
}[]

locations

management.locations Look up Rank Tracker location ids for a country Risk: read

await corsair.ahrefs.api.management.locations({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	A two-letter country code (ISO 3166-1 alpha-2).
`us_state`	`string`	No	A two-letter US state code (ISO 3166-2:US).
`output`	`json`	No	—

Output

Name	Type	Required	Description
`location`	`object`	Yes	—

location full type

{
  country_code?: string | null,
  languages?: any[] | null,
  locations?: any[] | null
}

projectCompetitors

management.projectCompetitors List competitors of a Rank Tracker project Risk: read

await corsair.ahrefs.api.management.projectCompetitors({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The unique identifier of the project.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`competitors`	`object[]`	Yes	—

competitors full type

{
  mode?: string | null,
  url?: string | null
}[]

projectKeywords

management.projectKeywords List keywords tracked in a Rank Tracker project Risk: read

await corsair.ahrefs.api.management.projectKeywords({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The unique identifier of the project.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  keyword?: string | null,
  language?: string | null,
  language_code?: string | null,
  location?: string | null,
  location_id?: number | null,
  tags?: string[] | null
}[]

projects

management.projects List Ahrefs projects in the workspace Risk: read

await corsair.ahrefs.api.management.projects({});

Input

Name	Type	Required	Description
`access`	`private \| shared`	No	The access type of the project.
`owned_by`	`string`	No	The email of the project owner
`project_id`	`number`	No	The unique identifier of the project.
`has_keywords`	`boolean`	No	Has Rank Tracker keywords.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`projects`	`object[]`	Yes	—

projects full type

{
  access?: string | null,
  folder?: Record<string, any> | null,
  keyword_count?: number | null,
  mode?: string | null,
  owned_by?: string | null,
  project_id?: string | null,
  project_name?: string | null,
  protocol?: string | null,
  url?: string | null,
  verified?: boolean | null,
  web_analytics_data_key?: string | null
}[]

updateBrandRadarPrompts

management.updateBrandRadarPrompts Change countries or tags of Brand Radar prompts Risk: write

await corsair.ahrefs.api.management.updateBrandRadarPrompts({});

Input

Name	Type	Required	Description
`report_id`	`string`	Yes	The ID of the report to use.
`output`	`json`	No	—
`prompts`	`string[]`	Yes	A list of custom prompts of the report to update.
`countries`	`object`	No	The country operation to apply to the prompts.
`tags`	`object`	No	The tag operation to apply to the prompts.

countries full type

{
  operation: add,
  countries: string[]
} | {
  operation: remove,
  countries: string[]
}

tags full type

{
  operation: add,
  tags: string[]
} | {
  operation: remove,
  tags: string[]
} | {
  operation: replace,
  tags: string[]
}

Output

Name	Type	Required	Description
`prompts`	`object[]`	Yes	—

prompts full type

{
  country?: string | null,
  created_at?: string | null,
  prompt?: string | null,
  tags?: string[] | null
}[]

updateBrandRadarReport

management.updateBrandRadarReport Update a Brand Radar report’s brands, countries or filters Risk: write

await corsair.ahrefs.api.management.updateBrandRadarReport({});

Input

Name	Type	Required	Description
`output`	`json`	No	—
`report_id`	`string`	Yes	The ID of the report to use.
`brand`	`object[]`	No	Replaces the saved brands.
`competitors`	`object[]`	No	Replaces the saved competitors.
`country`	`string[]`	No	Replaces the saved countries.
`where`	`Record<string, any>`	No	Filter expression as a JSON object; see the Ahrefs API docs for the fields this endpoint accepts.
`content_filter`	`object`	No	Replaces the saved content filter.
`prompts_frequency`	`object[]`	Yes	Data source frequencies; the API requires this on every update, so send the current values to keep them.

brand full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

competitors full type

{
  names?: string[],
  url_groups?: {
    target: string,
    scope: url | path | domain | subdomains
  }[]
}[]

content_filter full type

{
  include?: string[],
  exclude?: string[]
}

prompts_frequency full type

{
  data_source: chatgpt | google_ai_overviews | google_ai_mode | gemini | perplexity | copilot | claude | grok,
  frequency: daily | weekly | monthly | off
}[]

Output

Name	Type	Required	Description
`reports`	`object[]`	Yes	—

reports full type

{
  created_at?: string | null,
  project_id?: number | null,
  prompts_frequency?: any[] | null,
  report_id?: string | null,
  report_name?: string | null,
  settings?: Record<string, any> | null,
  updated_at?: string | null
}[]

updateProject

management.updateProject Change a project’s access or folder Risk: write

await corsair.ahrefs.api.management.updateProject({});

Input

Name	Type	Required	Description
`output`	`json`	No	—
`project_id`	`number`	Yes	The ID of the project whose access setting you want to update.
`folder`	`object`	No	A folder operation, applied before the access change.
`access`	`private \| shared`	No	The new access setting for the project.

folder full type

{
  operation: remove
} | {
  operation: move,
  folder_id: number
}

Output

Name	Type	Required	Description
`project`	`object`	Yes	—

project full type

{
  access?: string | null,
  folder?: Record<string, any> | null,
  mode?: string | null,
  project_id?: string | null,
  project_name?: string | null,
  protocol?: string | null,
  url?: string | null
}

Public

crawlerIpRanges

public.crawlerIpRanges List the IP ranges Ahrefs crawlers use Risk: read

await corsair.ahrefs.api.public.crawlerIpRanges({});

Input

Name	Type	Required	Description
`output`	`json`	No	—

Output

Name	Type	Required	Description
`prefixes`	`object[]`	Yes	—

prefixes full type

{
  ipv4Prefix?: string | null
}[]

crawlerIps

public.crawlerIps List the IP addresses Ahrefs crawlers use Risk: read

await corsair.ahrefs.api.public.crawlerIps({});

Input

Name	Type	Required	Description
`output`	`json`	No	—

Output

Name	Type	Required	Description
`ips`	`object[]`	Yes	—

ips full type

{
  ip_address?: string | null
}[]

domainRatingFree

public.domainRatingFree Get the free Domain Rating for one domain Risk: read

await corsair.ahrefs.api.public.domainRatingFree({});

Input

Name	Type	Required	Description
`target`	`string`	Yes	The target of the search: a domain or a URL.
`version`	`dr3 \| dr4`	No	The Domain Rating version.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`domain_rating`	`object`	Yes	—

domain_rating full type

{
  domain_rating?: number | null,
  license?: string | null
}

domainRatingFreeBatch

public.domainRatingFreeBatch Get the free Domain Rating for several domains Risk: read

await corsair.ahrefs.api.public.domainRatingFreeBatch({});

Input

Name	Type	Required	Description
`output`	`json`	No	—
`targets`	`string[]`	Yes	The targets of the search: domains or URLs.
`version`	`dr3 \| dr4`	No	The Domain Rating version.

Output

Name	Type	Required	Description
`domain_rating`	`object`	Yes	—

domain_rating full type

{
  license?: string | null,
  targets?: any[] | null
}

domainRatingTopDomains

public.domainRatingTopDomains List domains ranked by Domain Rating Risk: read

await corsair.ahrefs.api.public.domainRatingTopDomains({});

Input

Name	Type	Required	Description
`from`	`number`	No	Rank position to start from.
`to`	`number`	No	Rank position to end at.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`domains`	`object[]`	Yes	—

domains full type

{
  domain?: string | null,
  domain_rating?: number | null,
  rank?: number | null
}[]

Rank Tracker

competitorsDomains

rankTracker.competitorsDomains Compare traffic and share of voice of competitor domains in a Rank Tracker project Risk: read

await corsair.ahrefs.api.rankTracker.competitorsDomains({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A comma-separated list of columns to order results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`project_id`	`number`	Yes	The unique identifier of the project.
`device`	`desktop \| mobile`	Yes	Choose between mobile and desktop rankings.
`date`	`string`	Yes	A date to report metrics on in YYYY-MM-DD format.
`date_compared`	`string`	No	A date to compare metrics with in YYYY-MM-DD format.
`target_and_tracked_competitors_only`	`boolean`	No	Restrict domains to target and tracked competitors
`output`	`json`	No	—

Output

Name	Type	Required	Description
`competitors-domains`	`object[]`	Yes	—

competitors-domains full type

{
  domain?: string | null,
  keywords?: number | null,
  pages?: number | null,
  share_of_traffic_value?: number | null,
  share_of_traffic_value_prev?: number | null,
  share_of_voice?: number | null,
  share_of_voice_prev?: number | null,
  status?: string | null,
  traffic?: number | null,
  traffic_prev?: number | null,
  traffic_value?: number | null,
  traffic_value_prev?: number | null
}[]

competitorsOverview

rankTracker.competitorsOverview Compare positions of tracked keywords against project competitors Risk: read

await corsair.ahrefs.api.rankTracker.competitorsOverview({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A comma-separated list of columns to order results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`project_id`	`number`	Yes	The unique identifier of the project.
`device`	`desktop \| mobile`	Yes	Choose between mobile and desktop rankings.
`date`	`string`	Yes	A date to report metrics on in YYYY-MM-DD format.
`date_compared`	`string`	No	A date to compare metrics with in YYYY-MM-DD format.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  competitors_list?: any[] | null,
  country?: string | null,
  keyword?: string | null,
  keyword_difficulty?: number | null,
  keyword_has_data?: boolean | null,
  keyword_is_frozen?: boolean | null,
  language?: string | null,
  location?: string | null,
  serp_features?: string[] | null,
  serp_updated?: string | null,
  serp_updated_prev?: string | null,
  tags?: string[] | null,
  volume?: number | null
}[]

competitorsPages

rankTracker.competitorsPages List competitor pages ranking for a Rank Tracker project’s keywords Risk: read

await corsair.ahrefs.api.rankTracker.competitorsPages({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A comma-separated list of columns to order results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`project_id`	`number`	Yes	The unique identifier of the project.
`device`	`desktop \| mobile`	Yes	Choose between mobile and desktop rankings.
`date`	`string`	Yes	A date to report metrics on in YYYY-MM-DD format.
`date_compared`	`string`	No	A date to compare metrics with in YYYY-MM-DD format.
`target_and_tracked_competitors_only`	`boolean`	No	Restrict pages to target and tracked competitors
`output`	`json`	No	—

Output

Name	Type	Required	Description
`competitors-pages`	`object[]`	Yes	—

competitors-pages full type

{
  keywords?: number | null,
  share_of_traffic_value?: number | null,
  share_of_traffic_value_prev?: number | null,
  share_of_voice?: number | null,
  share_of_voice_prev?: number | null,
  status?: string | null,
  title?: string | null,
  title_prev?: string | null,
  traffic?: number | null,
  traffic_prev?: number | null,
  traffic_value?: number | null,
  traffic_value_prev?: number | null,
  url?: string | null
}[]

competitorsStats

rankTracker.competitorsStats Get position distribution and SERP feature counts for project competitors Risk: read

await corsair.ahrefs.api.rankTracker.competitorsStats({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`project_id`	`number`	Yes	The unique identifier of the project.
`device`	`desktop \| mobile`	Yes	Choose between mobile and desktop rankings.
`date`	`string`	Yes	A date to report metrics on in YYYY-MM-DD format.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`competitors-metrics`	`object[]`	Yes	—

competitors-metrics full type

{
  ai_overview_count?: number | null,
  average_position?: number | null,
  competitor?: string | null,
  discussions_count?: number | null,
  featured_snippet_count?: number | null,
  image_pack_count?: number | null,
  knowledge_card_count?: number | null,
  knowledge_panel_count?: number | null,
  pos_1_3?: number | null,
  pos_4_10?: number | null,
  pos_11_20?: number | null,
  pos_21_50?: number | null,
  pos_51_plus?: number | null,
  pos_no_rank?: number | null,
  share_of_traffic_value?: number | null,
  share_of_voice?: number | null,
  sitelinks_count?: number | null,
  thumbnail_count?: number | null,
  top_stories_count?: number | null,
  traffic?: number | null,
  traffic_value?: number | null,
  video_preview_count?: number | null,
  videos_count?: number | null,
  x_count?: number | null
}[]

overview

rankTracker.overview Get Rank Tracker keyword overview data for a project and device Risk: read

await corsair.ahrefs.api.rankTracker.overview({});

Input

Name	Type	Required	Description
`timeout`	`number`	No	—
`limit`	`number`	No	Defaults to 1000.
`order_by`	`string`	No	—
`where`	`string`	No	—
`select`	`string`	Yes	—
`date_compared`	`string`	No	—
`date`	`string`	Yes	—
`device`	`desktop \| mobile`	Yes	—
`project_id`	`number`	Yes	—
`volume_mode`	`monthly \| average`	No	Defaults to “monthly”.
`output`	`json`	No	Defaults to “json”.

Output

Name	Type	Required	Description
`overviews`	`object[]`	Yes	—

overviews full type

{
  keyword?: string | null,
  country?: string,
  device?: string,
  position?: number | null,
  previous_position?: number | null,
  best_position_kind?: string | null,
  clicks?: number | null,
  volume?: number | null,
  traffic?: number | null,
  url?: string | null
}[]

serpOverview

rankTracker.serpOverview Get the latest search results for a tracked keyword in a Rank Tracker project Risk: read

await corsair.ahrefs.api.rankTracker.serpOverview({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The unique identifier of the project.
`keyword`	`string`	Yes	The keyword to return SERP Overview for.
`language_code`	`string`	No	The language code of a tracked keyword.You can use the management/project-keywords endpoint to get country codes, language codes and location IDs for your track
`country`	`string`	Yes	A two-letter country code (ISO 3166-1 alpha-2).
`location_id`	`number`	No	The location ID of a tracked keyword.You can use the management/project-keywords endpoint to get country codes, language codes and location IDs for your tracked
`date`	`string`	No	A timestamp on which the last available SERP Overview is returned in YYYY-MM-DDThh:mm:ss format.
`device`	`desktop \| mobile`	Yes	Choose between mobile and desktop rankings.
`top_positions`	`number`	No	The number of top organic SERP positions to return.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`positions`	`object[]`	Yes	—

positions full type

{
  ahrefs_rank?: number | null,
  backlinks?: number | null,
  domain_rating?: number | null,
  keywords?: number | null,
  nr_words?: number | null,
  page_type?: string | null,
  position?: number | null,
  refdomains?: number | null,
  title?: string | null,
  top_keyword?: string | null,
  top_keyword_volume?: number | null,
  traffic?: number | null,
  type?: string[] | null,
  update_date?: string | null,
  url?: string | null,
  url_rating?: number | null,
  value?: number | null
}[]

Serp

overview

serp.overview Get SERP positions for a keyword and country, including ranking page metrics Risk: read

await corsair.ahrefs.api.serp.overview({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	—
`top_positions`	`number`	No	—
`date`	`string`	No	—
`country`	`string`	Yes	—
`keyword`	`string`	Yes	—
`output`	`json`	No	Defaults to “json”.

Output

Name	Type	Required	Description
`positions`	`object[]`	Yes	—

positions full type

{
  position: number,
  url?: string | null,
  title?: string | null,
  type?: string[],
  domain_rating?: number | null,
  ahrefs_rank?: number | null,
  backlinks?: number | null,
  refdomains?: number | null,
  traffic?: number | null,
  value?: number | null,
  update_date?: string | null
}[]

Site Audit

issues

siteAudit.issues List Site Audit issues for a project with affected URL counts Risk: read

await corsair.ahrefs.api.siteAudit.issues({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The unique identifier of the project.
`date`	`string`	No	A timestamp in YYYY-MM-DDThh:mm:ss format specifying the crawl date to retrieve metrics from.
`date_compared`	`string`	No	A timestamp in YYYY-MM-DDThh:mm:ss format specifying the crawl date to compare metrics with.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`issues`	`object[]`	Yes	—

issues full type

{
  added?: number | null,
  category?: string | null,
  change?: number | null,
  crawled?: number | null,
  importance?: string | null,
  is_indexable?: boolean | null,
  issue_id?: string | null,
  missing?: number | null,
  name?: string | null,
  new?: number | null,
  removed?: number | null
}[]

pageContent

siteAudit.pageContent Get the crawled content of one page from a Site Audit project Risk: read

await corsair.ahrefs.api.siteAudit.pageContent({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of fields to return.
`project_id`	`number`	Yes	The unique identifier of the project.
`target_url`	`string`	Yes	The URL of the page to retrieve content for.
`date`	`string`	No	A timestamp in YYYY-MM-DDThh:mm:ss format specifying the crawl date to retrieve metrics from.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`page-content`	`object`	Yes	—

page-content full type

{
  crawl_datetime?: string | null,
  page_text?: string | null,
  page_text_md?: string | null,
  raw_html?: string | null,
  rendered_html?: string | null
}

pageExplorer

siteAudit.pageExplorer List crawled pages from a Site Audit project, optionally only those with a given issue Risk: read

await corsair.ahrefs.api.siteAudit.pageExplorer({});

Input

Name	Type	Required	Description
`select`	`string`	No	A comma-separated list of fields to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A field to order the results by, with optional direction.
`project_id`	`number`	Yes	The unique identifier of the project.
`date`	`string`	No	A timestamp in YYYY-MM-DDThh:mm:ss format specifying the crawl date to retrieve metrics from.
`date_compared`	`string`	No	A timestamp in YYYY-MM-DDThh:mm:ss format specifying the crawl date to compare metrics with.
`issue_id`	`string`	No	The unique identifier of an issue.
`filter_mode`	`added \| new \| removed \| missing \| no_change`	No	Indicates which pages to return compared to the previous crawl.
`offset`	`number`	No	The number of results to skip.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  backlinks?: number | null,
  canonical?: string | null,
  compliant?: boolean | null,
  content_type?: string | null,
  depth?: number | null,
  h1?: string[] | null,
  http_code?: number | null,
  incoming_all_links?: number | null,
  incoming_links?: number | null,
  is_html?: boolean | null,
  is_valid_internal_html?: boolean | null,
  keywords?: string[] | null,
  loading_time?: number | null,
  meta_description?: string[] | null,
  origin?: string | null,
  page_rating?: number | null,
  redirect?: string | null,
  scheme?: string | null,
  size?: number | null,
  time_to_first_byte?: number | null,
  title?: string[] | null,
  traffic?: number | null,
  url?: string | null
}[]

projects

siteAudit.projects List Site Audit projects with health scores and issue counts Risk: read

await corsair.ahrefs.api.siteAudit.projects({});

Input

Name	Type	Required	Description
`project_id`	`number`	No	The unique identifier of the project.
`date`	`string`	No	A timestamp in YYYY-MM-DDThh:mm:ss format specifying the crawl date to retrieve metrics from.
`project_name`	`string`	No	Filters projects by name.
`project_url`	`string`	No	Filters projects by target URL (ignores protocol and trailing slash).
`output`	`json`	No	—

Output

Name	Type	Required	Description
`healthscores`	`object[]`	Yes	—

healthscores full type

{
  date?: string | null,
  health_score?: number | null,
  project_id?: string | null,
  project_name?: string | null,
  status?: string | null,
  target_mode?: string | null,
  target_protocol?: string | null,
  target_url?: string | null,
  total?: number | null,
  urls_with_errors?: number | null,
  urls_with_notices?: number | null,
  urls_with_warnings?: number | null
}[]

Site Explorer

aiResponsesCount

siteExplorer.aiResponsesCount Count AI assistant answers that cite a target, per platform Risk: read

await corsair.ahrefs.api.siteExplorer.aiResponsesCount({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of fields to return.
`date`	`string`	No	The date to report on in YYYY-MM-DD format.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`output`	`json`	No	—

Output

Name	Type	Required	Description
`ai_responses_count`	`object`	Yes	—

ai_responses_count full type

{
  all_platforms?: Record<string, any> | null,
  chatgpt?: Record<string, any> | null,
  copilot?: Record<string, any> | null,
  gemini?: Record<string, any> | null,
  google_ai_mode?: Record<string, any> | null,
  google_ai_mode_keywords?: Record<string, any> | null,
  google_ai_overviews?: Record<string, any> | null,
  google_ai_overviews_keywords?: Record<string, any> | null,
  grok?: Record<string, any> | null,
  perplexity?: Record<string, any> | null
}

allBacklinks

siteExplorer.allBacklinks List backlinks pointing to a target Risk: read

await corsair.ahrefs.api.siteExplorer.allBacklinks({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A column to order results by.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`aggregation`	`similar_links \| 1_per_domain \| all`	No	The backlinks grouping mode.
`history`	`string`	No	A time frame to add lost backlinks to the report.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the search based on the target you entered.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`backlinks`	`object[]`	Yes	—

backlinks full type

{
  ahrefs_rank_source?: number | null,
  ahrefs_rank_target?: number | null,
  alt?: string | null,
  anchor?: string | null,
  broken_redirect_new_target?: string | null,
  broken_redirect_reason?: string | null,
  broken_redirect_source?: string | null,
  class_c?: number | null,
  discovered_status?: string | null,
  domain_rating_source?: number | null,
  domain_rating_target?: number | null,
  drop_reason?: string | null,
  encoding?: string | null,
  first_seen?: string | null,
  first_seen_link?: string | null,
  http_code?: number | null,
  http_crawl?: boolean | null,
  ip_source?: string | null,
  is_alternate?: boolean | null,
  is_canonical?: boolean | null,
  is_content?: boolean | null,
  is_dofollow?: boolean | null,
  is_form?: boolean | null,
  is_frame?: boolean | null,
  is_image?: boolean | null,
  is_lost?: boolean | null,
  is_new?: boolean | null,
  is_nofollow?: boolean | null,
  is_redirect?: boolean | null,
  is_redirect_lost?: boolean | null,
  is_root_source?: boolean | null,
  is_root_target?: boolean | null,
  is_rss?: boolean | null,
  is_spam?: boolean | null,
  is_sponsored?: boolean | null,
  is_text?: boolean | null,
  is_ugc?: boolean | null,
  js_crawl?: boolean | null,
  languages?: string[] | null,
  last_seen?: string | null,
  last_visited?: string | null,
  link_group_count?: number | null,
  link_type?: string | null,
  linked_domains_source_domain?: number | null,
  linked_domains_source_page?: number | null,
  linked_domains_target_domain?: number | null,
  links_external?: number | null,
  links_internal?: number | null,
  lost_reason?: string | null,
  name_source?: string | null,
  name_target?: string | null,
  noindex?: boolean | null,
  page_category_source?: string | null,
  page_size?: number | null,
  page_type_source?: string | null,
  port_source?: number | null,
  port_target?: number | null,
  positions?: number | null,
  powered_by?: string[] | null,
  redirect_code?: number | null,
  redirect_kind?: number[] | null,
  refdomains_source?: number | null,
  refdomains_source_domain?: number | null,
  refdomains_target_domain?: number | null,
  root_name_source?: string | null,
  root_name_target?: string | null,
  snippet_left?: string | null,
  snippet_right?: string | null,
  source_page_author?: string | null,
  source_page_publish_date?: string | null,
  title?: string | null,
  tld_class_source?: string | null,
  tld_class_target?: string | null,
  traffic?: number | null,
  traffic_domain?: number | null,
  url_from?: string | null,
  url_from_plain?: string | null,
  url_rating_source?: number | null,
  url_redirect?: string[] | null,
  url_redirect_with_target?: string[] | null,
  url_to?: string | null,
  url_to_plain?: string | null
}[]

anchors

siteExplorer.anchors List anchor texts of backlinks pointing to a target Risk: read

await corsair.ahrefs.api.siteExplorer.anchors({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A comma-separated list of columns to order results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`history`	`string`	No	A time frame to add lost backlinks to the report.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the search based on the target you entered.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`anchors`	`object[]`	Yes	—

anchors full type

{
  anchor?: string | null,
  dofollow_links?: number | null,
  first_seen?: string | null,
  is_spam?: boolean | null,
  last_seen?: string | null,
  links_to_target?: number | null,
  lost_links?: number | null,
  new_links?: number | null,
  refdomains?: number | null,
  refpages?: number | null,
  top_domain_rating?: number | null
}[]

backlinksStats

siteExplorer.backlinksStats Get live and all-time backlink and referring-domain counts for a target Risk: read

await corsair.ahrefs.api.siteExplorer.backlinksStats({});

Input

Name	Type	Required	Description
`protocol`	`both \| http \| https`	No	Defaults to “both”.
`target`	`string`	Yes	—
`date`	`string`	Yes	—
`output`	`json`	No	Defaults to “json”.
`mode`	`exact \| prefix \| domain \| subdomains`	No	Defaults to “subdomains”.

Output

Name	Type	Required	Description
`metrics`	`object`	Yes	—

metrics full type

{
  all_time: number | null,
  all_time_refdomains: number | null,
  live: number | null,
  live_refdomains: number | null
}

brokenBacklinks

siteExplorer.brokenBacklinks List backlinks pointing to broken pages on a target Risk: read

await corsair.ahrefs.api.siteExplorer.brokenBacklinks({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A column to order results by.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`aggregation`	`similar_links \| 1_per_domain \| all`	No	The backlinks grouping mode.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the search based on the target you entered.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`backlinks`	`object[]`	Yes	—

backlinks full type

{
  ahrefs_rank_source?: number | null,
  ahrefs_rank_target?: number | null,
  alt?: string | null,
  anchor?: string | null,
  class_c?: number | null,
  domain_rating_source?: number | null,
  domain_rating_target?: number | null,
  encoding?: string | null,
  first_seen?: string | null,
  first_seen_link?: string | null,
  http_code?: number | null,
  http_code_target?: number | null,
  http_crawl?: boolean | null,
  ip_source?: string | null,
  is_alternate?: boolean | null,
  is_canonical?: boolean | null,
  is_content?: boolean | null,
  is_dofollow?: boolean | null,
  is_form?: boolean | null,
  is_frame?: boolean | null,
  is_image?: boolean | null,
  is_nofollow?: boolean | null,
  is_redirect?: boolean | null,
  is_root_source?: boolean | null,
  is_root_target?: boolean | null,
  is_rss?: boolean | null,
  is_spam?: boolean | null,
  is_sponsored?: boolean | null,
  is_text?: boolean | null,
  is_ugc?: boolean | null,
  js_crawl?: boolean | null,
  languages?: string[] | null,
  last_seen?: string | null,
  last_visited?: string | null,
  last_visited_target?: string | null,
  link_group_count?: number | null,
  link_type?: string | null,
  linked_domains_source_domain?: number | null,
  linked_domains_source_page?: number | null,
  linked_domains_target_domain?: number | null,
  links_external?: number | null,
  links_internal?: number | null,
  name_source?: string | null,
  name_target?: string | null,
  page_category_source?: string | null,
  page_size?: number | null,
  page_type_source?: string | null,
  port_source?: number | null,
  port_target?: number | null,
  positions?: number | null,
  powered_by?: string[] | null,
  redirect_code?: number | null,
  redirect_kind?: number[] | null,
  refdomains_source?: number | null,
  refdomains_source_domain?: number | null,
  refdomains_target_domain?: number | null,
  root_name_source?: string | null,
  root_name_target?: string | null,
  snippet_left?: string | null,
  snippet_right?: string | null,
  source_page_author?: string | null,
  title?: string | null,
  tld_class_source?: string | null,
  tld_class_target?: string | null,
  traffic?: number | null,
  traffic_domain?: number | null,
  url_from?: string | null,
  url_from_plain?: string | null,
  url_rating_source?: number | null,
  url_redirect?: string[] | null,
  url_redirect_with_target?: string[] | null,
  url_to?: string | null,
  url_to_plain?: string | null
}[]

crawledPages

siteExplorer.crawledPages List pages of a target that Ahrefs has crawled, with status and type Risk: read

await corsair.ahrefs.api.siteExplorer.crawledPages({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of fields to return.
`order_by`	`string`	No	A field to order the results by, with optional direction.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`limit`	`number`	No	The number of results to return.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  first_seen?: string | null,
  http_code?: number | null,
  languages?: string[] | null,
  last_attempt?: string | null,
  last_crawled?: string | null,
  page_category?: string | null,
  page_type?: string | null,
  publish_date?: string | null,
  title?: string | null,
  url?: string | null,
  url_rating?: number | null
}[]

domainRatingHistory

siteExplorer.domainRatingHistory Get Domain Rating history for a target Risk: read

await corsair.ahrefs.api.siteExplorer.domainRatingHistory({});

Input

Name	Type	Required	Description
`target`	`string`	Yes	The target of the search: a domain or a URL.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`domain_ratings`	`object[]`	Yes	—

domain_ratings full type

{
  date?: string | null,
  domain_rating?: number | null
}[]

getDomainRating

siteExplorer.getDomainRating Get Ahrefs Domain Rating and Ahrefs Rank for a target Risk: read

await corsair.ahrefs.api.siteExplorer.getDomainRating({});

Input

Name	Type	Required	Description
`protocol`	`both \| http \| https`	No	Defaults to “both”.
`target`	`string`	Yes	—
`date`	`string`	Yes	—
`output`	`json`	No	Defaults to “json”.

Output

Name	Type	Required	Description
`domain_rating`	`object`	Yes	—

domain_rating full type

{
  ahrefs_rank: number | null,
  domain_rating: number | null
}

keywordsHistory

siteExplorer.keywordsHistory Get organic keyword counts by position bucket over time for a target Risk: read

await corsair.ahrefs.api.siteExplorer.keywordsHistory({});

Input

Name	Type	Required	Description
`select`	`string`	No	A comma-separated list of columns to return.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  date?: string | null,
  top3?: number | null,
  top4_10?: number | null,
  top11_20?: number | null,
  top11_plus?: number | null,
  top21_50?: number | null,
  top51_plus?: number | null
}[]

linkedAnchorsExternal

siteExplorer.linkedAnchorsExternal List anchor texts a target uses in its outgoing external links Risk: read

await corsair.ahrefs.api.siteExplorer.linkedAnchorsExternal({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A comma-separated list of columns to order results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the search based on the target you entered.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`linkedanchors`	`object[]`	Yes	—

linkedanchors full type

{
  anchor?: string | null,
  dofollow_links?: number | null,
  first_seen?: string | null,
  linked_domains?: number | null,
  linked_pages?: number | null,
  links_from_target?: number | null
}[]

linkedAnchorsInternal

siteExplorer.linkedAnchorsInternal List anchor texts a target uses in its internal links Risk: read

await corsair.ahrefs.api.siteExplorer.linkedAnchorsInternal({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A comma-separated list of columns to order results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the search based on the target you entered.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`linkedanchors`	`object[]`	Yes	—

linkedanchors full type

{
  anchor?: string | null,
  dofollow_links?: number | null,
  first_seen?: string | null,
  linked_pages?: number | null,
  links_from_target?: number | null
}[]

linkedDomains

siteExplorer.linkedDomains List external domains a target links to Risk: read

await corsair.ahrefs.api.siteExplorer.linkedDomains({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A comma-separated list of columns to order results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the search based on the target you entered.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`linkeddomains`	`object[]`	Yes	—

linkeddomains full type

{
  dofollow_linked_domains?: number | null,
  dofollow_links?: number | null,
  dofollow_refdomains?: number | null,
  domain?: string | null,
  domain_rating?: number | null,
  first_seen?: string | null,
  is_root_domain?: boolean | null,
  linked_domain_traffic?: number | null,
  linked_pages?: number | null,
  links_from_target?: number | null
}[]

metrics

siteExplorer.metrics Get organic and paid traffic, keyword and value metrics for a target Risk: read

await corsair.ahrefs.api.siteExplorer.metrics({});

Input

Name	Type	Required	Description
`date`	`string`	Yes	A date to report metrics on in YYYY-MM-DD format.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`traffic_mode`	`static \| adaptive`	No	The organic traffic calculation mode: static or adaptive.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object`	Yes	—

metrics full type

{
  org_cost?: number | null,
  org_keywords?: number | null,
  org_keywords_1_3?: number | null,
  org_traffic?: number | null,
  paid_cost?: number | null,
  paid_keywords?: number | null,
  paid_pages?: number | null,
  paid_traffic?: number | null
}

metricsByCountry

siteExplorer.metricsByCountry Get organic and paid traffic metrics for a target split by country Risk: read

await corsair.ahrefs.api.siteExplorer.metricsByCountry({});

Input

Name	Type	Required	Description
`select`	`string`	No	A comma-separated list of columns to return.
`limit`	`number`	No	The number of results to return.
`date`	`string`	Yes	A date to report metrics on in YYYY-MM-DD format.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`traffic_mode`	`static \| adaptive`	No	The organic traffic calculation mode: static or adaptive.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  country?: string | null,
  org_cost?: number | null,
  org_keywords?: number | null,
  org_keywords_1_3?: number | null,
  org_traffic?: number | null,
  paid_cost?: number | null,
  paid_keywords?: number | null,
  paid_pages?: number | null,
  paid_traffic?: number | null
}[]

metricsHistory

siteExplorer.metricsHistory Get organic and paid traffic and value history for a target Risk: read

await corsair.ahrefs.api.siteExplorer.metricsHistory({});

Input

Name	Type	Required	Description
`select`	`string`	No	A comma-separated list of columns to return.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`traffic_mode`	`static \| adaptive`	No	The organic traffic calculation mode: static or adaptive.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  org_cost?: number | null,
  org_traffic?: number | null,
  paid_cost?: number | null,
  paid_traffic?: number | null
}[]

organicCompetitors

siteExplorer.organicCompetitors List sites that compete with a target for the same organic keywords Risk: read

await corsair.ahrefs.api.siteExplorer.organicCompetitors({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A comma-separated list of columns to order results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`traffic_mode`	`static \| adaptive`	No	The organic traffic calculation mode: static or adaptive.
`date`	`string`	Yes	A date to report metrics on in YYYY-MM-DD format.
`date_compared`	`string`	No	A date to compare metrics with in YYYY-MM-DD format.
`country`	`string`	Yes	A two-letter country code (ISO 3166-1 alpha-2).
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the search based on the target you entered.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`competitors`	`object[]`	Yes	—

competitors full type

{
  competitor_domain?: string | null,
  competitor_url?: string | null,
  domain_rating?: number | null,
  group_mode?: string | null,
  keywords_common?: number | null,
  keywords_competitor?: number | null,
  keywords_target?: number | null,
  pages?: number | null,
  pages_diff?: number | null,
  pages_merged?: number | null,
  pages_prev?: number | null,
  share?: number | null,
  traffic?: number | null,
  traffic_diff?: number | null,
  traffic_merged?: number | null,
  traffic_prev?: number | null,
  value?: number | null,
  value_diff?: number | null,
  value_merged?: number | null,
  value_prev?: number | null
}[]

organicKeywords

siteExplorer.organicKeywords List organic keywords a target ranks for, including positions and traffic metrics Risk: read

await corsair.ahrefs.api.siteExplorer.organicKeywords({});

Input

Name	Type	Required	Description
`protocol`	`both \| http \| https`	No	Defaults to “both”.
`target`	`string`	Yes	—
`date`	`string`	Yes	—
`output`	`json`	No	Defaults to “json”.
`timeout`	`number`	No	—
`limit`	`number`	No	Defaults to 1000.
`order_by`	`string`	No	—
`where`	`string`	No	—
`select`	`string`	Yes	—
`mode`	`exact \| prefix \| domain \| subdomains`	No	Defaults to “subdomains”.
`country`	`string`	Yes	—
`date_compared`	`string`	No	—
`volume_mode`	`monthly \| average`	No	Defaults to “monthly”.

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  keyword?: string | null,
  keyword_country?: string,
  best_position?: number | null,
  best_position_url?: string | null,
  keyword_difficulty?: number | null,
  volume?: number | null,
  cpc?: number | null,
  sum_traffic?: number | null,
  serp_features?: string[],
  last_update?: string | null,
  status?: string
}[]

outlinksStats

siteExplorer.outlinksStats Get counts of outgoing links and linked domains for a target Risk: read

await corsair.ahrefs.api.siteExplorer.outlinksStats({});

Input

Name	Type	Required	Description
`target`	`string`	Yes	The target of the search: a domain or a URL.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object`	Yes	—

metrics full type

{
  linked_domains?: number | null,
  linked_domains_dofollow?: number | null,
  outgoing_links?: number | null,
  outgoing_links_dofollow?: number | null
}

pagesByBacklinks

siteExplorer.pagesByBacklinks List pages of a target ranked by backlinks and referring domains Risk: read

await corsair.ahrefs.api.siteExplorer.pagesByBacklinks({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A column to order results by.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`history`	`string`	No	A time frame to add lost backlinks to the report.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the search based on the target you entered.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  dofollow_to_target?: number | null,
  first_seen_link?: string | null,
  http_code_target?: number | null,
  is_spam?: boolean | null,
  languages_target?: string[] | null,
  last_seen?: string | null,
  last_visited_source?: string | null,
  last_visited_target?: string | null,
  links_to_target?: number | null,
  lost_links_to_target?: number | null,
  new_links_to_target?: number | null,
  nofollow_to_target?: number | null,
  page_type_target?: string | null,
  powered_by_target?: string[] | null,
  redirects_to_target?: number | null,
  refdomains_target?: number | null,
  target_redirect?: string | null,
  title_target?: string | null,
  top_domain_rating_source?: number | null,
  url_rating_target?: number | null,
  url_to?: string | null,
  url_to_plain?: string | null
}[]

pagesByInternalLinks

siteExplorer.pagesByInternalLinks List pages of a target ranked by internal links pointing to them Risk: read

await corsair.ahrefs.api.siteExplorer.pagesByInternalLinks({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A column to order results by.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the search based on the target you entered.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  canonical_to_target?: number | null,
  dofollow_to_target?: number | null,
  first_seen_link?: string | null,
  http_code_target?: number | null,
  languages_target?: string[] | null,
  last_seen?: string | null,
  last_visited_source?: string | null,
  last_visited_target?: string | null,
  links_to_target?: number | null,
  nofollow_to_target?: number | null,
  page_type_target?: string | null,
  powered_by_target?: string[] | null,
  redirects_to_target?: number | null,
  target_redirect?: string | null,
  title_target?: string | null,
  url_rating_target?: number | null,
  url_to?: string | null,
  url_to_plain?: string | null
}[]

pagesByTraffic

siteExplorer.pagesByTraffic Get how many pages of a target fall into each organic traffic range Risk: read

await corsair.ahrefs.api.siteExplorer.pagesByTraffic({});

Input

Name	Type	Required	Description
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`traffic_mode`	`static \| adaptive`	No	The organic traffic calculation mode: static or adaptive.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`output`	`json`	No	—

Output

Name	Type	Required	Description
`pages`	`object`	Yes	—

pages full type

{
  range0_pages?: number | null,
  range1k_pages?: number | null,
  range1k_traffic?: number | null,
  range5k_pages?: number | null,
  range5k_traffic?: number | null,
  range10k_pages?: number | null,
  range10k_plus_pages?: number | null,
  range10k_plus_traffic?: number | null,
  range10k_traffic?: number | null,
  range100_pages?: number | null,
  range100_traffic?: number | null
}

pagesHistory

siteExplorer.pagesHistory Get the number of ranking pages of a target over time Risk: read

await corsair.ahrefs.api.siteExplorer.pagesHistory({});

Input

Name	Type	Required	Description
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`page_positions`	`top10 \| top100`	No	Filter pages by their ranking position.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  date?: string | null,
  pages?: number | null
}[]

paidPages

siteExplorer.paidPages List pages of a target that get paid search traffic Risk: read

await corsair.ahrefs.api.siteExplorer.paidPages({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	A comma-separated list of columns to return.
`where`	`string`	No	Filter expression as a JSON string; see the Ahrefs API docs for the fields this endpoint accepts.
`order_by`	`string`	No	A comma-separated list of columns to order results by, with optional direction.
`limit`	`number`	No	The number of results to return.
`timeout`	`number`	No	A manual timeout duration in seconds.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`date`	`string`	Yes	A date to report metrics on in YYYY-MM-DD format.
`date_compared`	`string`	No	A date to compare metrics with in YYYY-MM-DD format.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the search based on the target you entered.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  ads_count?: number | null,
  ads_count_diff?: number | null,
  ads_count_prev?: number | null,
  keywords?: number | null,
  keywords_diff?: number | null,
  keywords_diff_percent?: number | null,
  keywords_merged?: number | null,
  keywords_prev?: number | null,
  raw_url?: string | null,
  raw_url_prev?: string | null,
  referring_domains?: number | null,
  status?: string | null,
  sum_traffic?: number | null,
  sum_traffic_merged?: number | null,
  sum_traffic_prev?: number | null,
  top_keyword?: string | null,
  top_keyword_best_position?: number | null,
  top_keyword_best_position_diff?: number | null,
  top_keyword_best_position_kind?: string | null,
  top_keyword_best_position_kind_prev?: string | null,
  top_keyword_best_position_prev?: number | null,
  top_keyword_best_position_title?: string | null,
  top_keyword_best_position_title_prev?: string | null,
  top_keyword_country?: string | null,
  top_keyword_country_prev?: string | null,
  top_keyword_prev?: string | null,
  top_keyword_volume?: number | null,
  top_keyword_volume_prev?: number | null,
  traffic_diff?: number | null,
  traffic_diff_percent?: number | null,
  ur?: number | null,
  url?: string | null,
  url_prev?: string | null,
  value?: number | null,
  value_diff?: number | null,
  value_diff_percent?: number | null,
  value_merged?: number | null,
  value_prev?: number | null
}[]

refdomains

siteExplorer.refdomains List referring domains linking to a target Risk: read

await corsair.ahrefs.api.siteExplorer.refdomains({});

Input

Name	Type	Required	Description
`protocol`	`both \| http \| https`	No	Defaults to “both”.
`target`	`string`	Yes	—
`date`	`string`	Yes	—
`output`	`json`	No	Defaults to “json”.
`timeout`	`number`	No	—
`limit`	`number`	No	Defaults to 1000.
`order_by`	`string`	No	—
`where`	`string`	No	—
`select`	`string`	Yes	—
`mode`	`exact \| prefix \| domain \| subdomains`	No	Defaults to “subdomains”.
`history`	`string`	No	Defaults to “all_time”.

Output

Name	Type	Required	Description
`refdomains`	`object[]`	Yes	—

refdomains full type

{
  domain: string,
  domain_rating?: number | null,
  dofollow_links?: number | null,
  dofollow_refdomains?: number | null,
  links?: number | null,
  refdomains?: number | null,
  first_seen?: string | null,
  last_visited?: string | null
}[]

refdomainsHistory

siteExplorer.refdomainsHistory Get referring domains count history for a target Risk: read

await corsair.ahrefs.api.siteExplorer.refdomainsHistory({});

Input

Name	Type	Required	Description
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`refdomains`	`object[]`	Yes	—

refdomains full type

{
  date?: string | null,
  refdomains?: number | null
}[]

topPages

siteExplorer.topPages List top organic pages for a target with traffic, keyword, and link metrics Risk: read

await corsair.ahrefs.api.siteExplorer.topPages({});

Input

Name	Type	Required	Description
`protocol`	`both \| http \| https`	No	Defaults to “both”.
`target`	`string`	Yes	—
`date`	`string`	Yes	—
`output`	`json`	No	Defaults to “json”.
`timeout`	`number`	No	—
`limit`	`number`	No	Defaults to 1000.
`order_by`	`string`	No	—
`where`	`string`	No	—
`select`	`string`	Yes	—
`mode`	`exact \| prefix \| domain \| subdomains`	No	Defaults to “subdomains”.
`country`	`string`	Yes	—
`date_compared`	`string`	No	—
`volume_mode`	`monthly \| average`	No	Defaults to “monthly”.

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  raw_url: string,
  keywords?: number | null,
  referring_domains?: number | null,
  sum_traffic?: number | null,
  value?: number | null,
  page_type?: string | null,
  status?: string
}[]

totalSearchVolumeHistory

siteExplorer.totalSearchVolumeHistory Get the total search volume of keywords a target ranks for over time Risk: read

await corsair.ahrefs.api.siteExplorer.totalSearchVolumeHistory({});

Input

Name	Type	Required	Description
`mode`	`exact \| prefix \| domain \| subdomains`	No	The scope of the target.
`target`	`string`	Yes	The target of the search: a domain or a URL.
`portfolio_id`	`number`	No	The unique identifier of the portfolio.
`protocol`	`both \| http \| https`	No	The protocol of your target.
`country`	`string`	No	A two-letter country code (ISO 3166-1 alpha-2).
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`top_positions`	`top_10 \| top_100`	No	The number of top organic search positions to consider when calculating total search volume.
`volume_mode`	`monthly \| average`	No	The search volume calculation mode: monthly or average.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  date?: string | null,
  total_search_volume?: number | null
}[]

urlRatingHistory

siteExplorer.urlRatingHistory Get URL Rating history for a page Risk: read

await corsair.ahrefs.api.siteExplorer.urlRatingHistory({});

Input

Name	Type	Required	Description
`target`	`string`	Yes	The target of the search: a domain or a URL.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`history_grouping`	`daily \| weekly \| monthly`	No	The time interval used to group historical data.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`url_ratings`	`object[]`	Yes	—

url_ratings full type

{
  date?: string | null,
  url_rating?: number | null
}[]

activityHistory

socialMedia.activityHistory List the activity log of a social media post Risk: read

await corsair.ahrefs.api.socialMedia.activityHistory({});

Input

Name	Type	Required	Description
`post_id`	`number`	Yes	Unique identifier for the post.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`activities`	`object[]`	Yes	—

activities full type

{
  action_type?: string | null,
  activity_id?: number | null,
  channel_id?: string | null,
  channel_kind?: string | null,
  created_at?: string | null,
  user_name?: string | null
}[]

authors

socialMedia.authors List social media post authors in the workspace Risk: read

await corsair.ahrefs.api.socialMedia.authors({});

Input

Name	Type	Required	Description
`output`	`json`	No	—

Output

Name	Type	Required	Description
`authors`	`object[]`	Yes	—

authors full type

{
  author_id?: string | null,
  author_name?: string | null
}[]

channelMetrics

socialMedia.channelMetrics Get follower count history for a social media channel Risk: read

await corsair.ahrefs.api.socialMedia.channelMetrics({});

Input

Name	Type	Required	Description
`channel_id`	`string`	Yes	Unique identifier for the social media channel.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  follower_count?: number | null,
  retrieved_at?: string | null
}[]

channels

socialMedia.channels List connected social media channels Risk: read

await corsair.ahrefs.api.socialMedia.channels({});

Input

Name	Type	Required	Description
`output`	`json`	No	—

Output

Name	Type	Required	Description
`channels`	`object[]`	Yes	—

channels full type

{
  channel_display_name?: string | null,
  channel_id?: string | null,
  channel_kind?: string | null,
  channel_profile_image_url?: string | null,
  channel_status?: string | null,
  channel_username?: string | null,
  external_channel_id?: string | null,
  token_validity?: string | null
}[]

createPost

socialMedia.createPost Create a social media post: publish now, schedule it or save a draft Risk: write

await corsair.ahrefs.api.socialMedia.createPost({});

Input

Name	Type	Required	Description
`output`	`json`	No	—
`channel_ids`	`string[]`	Yes	Non-empty list of channel IDs to publish the post to.
`text_content`	`string`	Yes	Text content of the post.
`timing`	`publish_now \| scheduled \| draft`	Yes	When to publish the post.
`scheduled_at`	`string`	No	Timestamp for scheduled posts (required when timing is scheduled)
`auto_comment`	`string`	No	Auto-comment text posted after publishing.

Output

Name	Type	Required	Description
`post`	`object`	Yes	—

post full type

{
  author_id?: string | null,
  author_name?: string | null,
  auto_comment?: string | null,
  channels?: any[] | null,
  created_at?: string | null,
  external_post_id?: string | null,
  permalink?: string | null,
  post_id?: number | null,
  status_timestamp?: string | null,
  text_content?: string | null
}

deletePost

socialMedia.deletePost Delete a social media post Risk: destructive

await corsair.ahrefs.api.socialMedia.deletePost({});

Input

Name	Type	Required	Description
`output`	`json`	No	—
`post_id`	`number`	Yes	Unique identifier for the post.

Output

Name	Type	Required	Description
`post`	`object`	Yes	—

post full type

{
  author_id?: string | null,
  author_name?: string | null,
  auto_comment?: string | null,
  channels?: any[] | null,
  created_at?: string | null,
  external_post_id?: string | null,
  permalink?: string | null,
  post_id?: number | null,
  status_timestamp?: string | null,
  text_content?: string | null
}

postMetrics

socialMedia.postMetrics Get views, likes and platform metrics for a published post Risk: read

await corsair.ahrefs.api.socialMedia.postMetrics({});

Input

Name	Type	Required	Description
`external_post_id`	`string`	Yes	Platform-specific post identifier.
`channel_id`	`string`	Yes	Unique identifier for the social media channel.
`date_from`	`string`	Yes	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`metrics`	`object[]`	Yes	—

metrics full type

{
  facebook_metrics?: Record<string, any> | null,
  instagram_metrics?: Record<string, any> | null,
  likes?: number | null,
  linkedin_metrics?: Record<string, any> | null,
  retrieved_at?: string | null,
  threads_metrics?: Record<string, any> | null,
  tiktok_metrics?: Record<string, any> | null,
  twitter_metrics?: Record<string, any> | null,
  unique_views?: number | null,
  views?: number | null,
  youtube_metrics?: Record<string, any> | null
}[]

posts

socialMedia.posts List social media posts by status, channel or author Risk: read

await corsair.ahrefs.api.socialMedia.posts({});

Input

Name	Type	Required	Description
`status`	`published \| scheduled \| draft \| failed \| deleted`	Yes	The publishing lifecycle stage of the post.
`channel_ids`	`string`	No	Comma-separated list of channel IDs to filter by.
`author_ids`	`string`	No	Comma-separated list of author user IDs to filter by.
`search_query`	`string`	No	Text search query to filter posts by content.
`date_from`	`string`	No	The start date of the historical period in YYYY-MM-DD format.
`date_to`	`string`	No	The end date of the historical period in YYYY-MM-DD format.
`order_by`	`date \| views \| unique_views \| comments \| likes`	No	Sort field for posts.
`order_direction`	`asc \| desc`	No	The order in which results are returned, ascending or descending.
`limit`	`number`	No	The number of results to return.
`offset`	`number`	No	The number of results to skip.
`output`	`json`	No	—

Output

Name	Type	Required	Description
`posts`	`object[]`	Yes	—

posts full type

{
  author_id?: string | null,
  author_name?: string | null,
  auto_comment?: string | null,
  channels?: any[] | null,
  created_at?: string | null,
  external_post_id?: string | null,
  permalink?: string | null,
  post_id?: number | null,
  status_timestamp?: string | null,
  text_content?: string | null
}[]

updatePost

socialMedia.updatePost Update a social media post’s text, channels or timing Risk: write

await corsair.ahrefs.api.socialMedia.updatePost({});

Input

Name	Type	Required	Description
`output`	`json`	No	—
`post_id`	`number`	Yes	Unique identifier for the post.
`channel_ids`	`string[]`	No	Non-empty list of channel IDs to publish the post to.
`text_content`	`string`	No	Text content of the post.
`timing`	`publish_now \| scheduled \| draft`	No	When to publish the post.
`scheduled_at`	`string`	No	Timestamp for scheduled posts (required when timing is scheduled)
`auto_comment`	`string`	No	Auto-comment text posted after publishing.

Output

Name	Type	Required	Description
`post`	`object`	Yes	—

post full type

{
  author_id?: string | null,
  author_name?: string | null,
  auto_comment?: string | null,
  channels?: any[] | null,
  created_at?: string | null,
  external_post_id?: string | null,
  permalink?: string | null,
  post_id?: number | null,
  status_timestamp?: string | null,
  text_content?: string | null
}

Subscription Info

limitsAndUsage

subscriptionInfo.limitsAndUsage Get Ahrefs subscription limits and API unit usage Risk: read

await corsair.ahrefs.api.subscriptionInfo.limitsAndUsage({});

Input

Name	Type	Required	Description
`output`	`json`	No	Defaults to “json”.

Output

Name	Type	Required	Description
`limits_and_usage`	`object`	Yes	—

limits_and_usage full type

{
  api_key_expiration_date: string,
  subscription: string,
  units_limit_api_key: number | null,
  units_limit_workspace: number | null,
  units_usage_api_key: number,
  units_usage_workspace: number | null,
  usage_reset_date: string
}

Web Analytics

browsers

webAnalytics.browsers Web Analytics: list visitors by browser Risk: read

await corsair.ahrefs.api.webAnalytics.browsers({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  browser?: string | null
}[]

browsersChart

webAnalytics.browsersChart Web Analytics: chart visitors by browser over time Risk: read

await corsair.ahrefs.api.webAnalytics.browsersChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`browser_to_chart`	`string`	No	Comma-separated browser values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  browser?: string | null,
  timestamp?: string | null
}[]

browserVersions

webAnalytics.browserVersions Web Analytics: list visitors by browser version Risk: read

await corsair.ahrefs.api.webAnalytics.browserVersions({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  browser_version?: string | null
}[]

browserVersionsChart

webAnalytics.browserVersionsChart Web Analytics: chart visitors by browser version over time Risk: read

await corsair.ahrefs.api.webAnalytics.browserVersionsChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`browser_version_to_chart`	`string`	No	Comma-separated browser version values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  browser_version?: string | null,
  timestamp?: string | null
}[]

chart

webAnalytics.chart Web Analytics: chart visitors, visits and pageviews over time Risk: read

await corsair.ahrefs.api.webAnalytics.chart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  timestamp?: string | null
}[]

cities

webAnalytics.cities Web Analytics: list visitors by city Risk: read

await corsair.ahrefs.api.webAnalytics.cities({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  city?: string | null
}[]

citiesChart

webAnalytics.citiesChart Web Analytics: chart visitors by city over time Risk: read

await corsair.ahrefs.api.webAnalytics.citiesChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`cities_to_chart`	`string`	No	Comma-separated city values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  city?: string | null,
  timestamp?: string | null
}[]

continents

webAnalytics.continents Web Analytics: list visitors by continent Risk: read

await corsair.ahrefs.api.webAnalytics.continents({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  continent?: string | null
}[]

continentsChart

webAnalytics.continentsChart Web Analytics: chart visitors by continent over time Risk: read

await corsair.ahrefs.api.webAnalytics.continentsChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`continents_to_chart`	`string`	No	Comma-separated continent values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  continent?: string | null,
  timestamp?: string | null
}[]

countries

webAnalytics.countries Web Analytics: list visitors by country Risk: read

await corsair.ahrefs.api.webAnalytics.countries({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  country?: string | null
}[]

countriesChart

webAnalytics.countriesChart Web Analytics: chart visitors by country over time Risk: read

await corsair.ahrefs.api.webAnalytics.countriesChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`countries_to_chart`	`string`	No	Comma-separated country values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  country?: string | null,
  timestamp?: string | null
}[]

devices

webAnalytics.devices Web Analytics: list visitors by device type Risk: read

await corsair.ahrefs.api.webAnalytics.devices({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  device?: string | null
}[]

devicesChart

webAnalytics.devicesChart Web Analytics: chart visitors by device type over time Risk: read

await corsair.ahrefs.api.webAnalytics.devicesChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`devices_to_chart`	`string`	No	Comma-separated device type values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  device?: string | null,
  timestamp?: string | null
}[]

entryPages

webAnalytics.entryPages Web Analytics: list visitors by entry page Risk: read

await corsair.ahrefs.api.webAnalytics.entryPages({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  entry_page?: string | null
}[]

entryPagesChart

webAnalytics.entryPagesChart Web Analytics: chart visitors by entry page over time Risk: read

await corsair.ahrefs.api.webAnalytics.entryPagesChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`entry_pages_to_chart`	`string`	No	Comma-separated entry page values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  entry_page?: string | null,
  timestamp?: string | null
}[]

exitPages

webAnalytics.exitPages Web Analytics: list visitors by exit page Risk: read

await corsair.ahrefs.api.webAnalytics.exitPages({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  exit_page?: string | null
}[]

exitPagesChart

webAnalytics.exitPagesChart Web Analytics: chart visitors by exit page over time Risk: read

await corsair.ahrefs.api.webAnalytics.exitPagesChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`exit_pages_to_chart`	`string`	No	Comma-separated exit page values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  exit_page?: string | null,
  timestamp?: string | null
}[]

languages

webAnalytics.languages Web Analytics: list visitors by browser language Risk: read

await corsair.ahrefs.api.webAnalytics.languages({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  browser_language?: string | null
}[]

languagesChart

webAnalytics.languagesChart Web Analytics: chart visitors by browser language over time Risk: read

await corsair.ahrefs.api.webAnalytics.languagesChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`browser_language_to_chart`	`string`	No	Comma-separated browser language values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  browser_language?: string | null,
  timestamp?: string | null
}[]

operatingSystems

webAnalytics.operatingSystems Web Analytics: list visitors by operating system Risk: read

await corsair.ahrefs.api.webAnalytics.operatingSystems({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  os?: string | null
}[]

operatingSystemsChart

webAnalytics.operatingSystemsChart Web Analytics: chart visitors by operating system over time Risk: read

await corsair.ahrefs.api.webAnalytics.operatingSystemsChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`os_to_chart`	`string`	No	Comma-separated operating system values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  os?: string | null,
  timestamp?: string | null
}[]

operatingSystemsVersions

webAnalytics.operatingSystemsVersions Web Analytics: list visitors by operating system version Risk: read

await corsair.ahrefs.api.webAnalytics.operatingSystemsVersions({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  os_version?: string | null
}[]

operatingSystemsVersionsChart

webAnalytics.operatingSystemsVersionsChart Web Analytics: chart visitors by operating system version over time Risk: read

await corsair.ahrefs.api.webAnalytics.operatingSystemsVersionsChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`os_versions_to_chart`	`string`	No	Comma-separated operating system version values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  os_version?: string | null,
  timestamp?: string | null
}[]

referrers

webAnalytics.referrers Web Analytics: list visitors by referrer Risk: read

await corsair.ahrefs.api.webAnalytics.referrers({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  source_referer?: string | null
}[]

referrersChart

webAnalytics.referrersChart Web Analytics: chart visitors by referrer over time Risk: read

await corsair.ahrefs.api.webAnalytics.referrersChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`source_referers_to_chart`	`string`	No	Comma-separated referrer values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  source_referer?: string | null,
  timestamp?: string | null
}[]

sourceChannels

webAnalytics.sourceChannels Web Analytics: list visitors by source channel Risk: read

await corsair.ahrefs.api.webAnalytics.sourceChannels({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  source_channel?: string | null
}[]

sourceChannelsChart

webAnalytics.sourceChannelsChart Web Analytics: chart visitors by source channel over time Risk: read

await corsair.ahrefs.api.webAnalytics.sourceChannelsChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`source_channels_to_chart`	`string`	No	Comma-separated source channel values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  source_channel?: string | null,
  timestamp?: string | null
}[]

sources

webAnalytics.sources Web Analytics: list visitors by traffic source Risk: read

await corsair.ahrefs.api.webAnalytics.sources({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  source?: string | null
}[]

sourcesChart

webAnalytics.sourcesChart Web Analytics: chart visitors by traffic source over time Risk: read

await corsair.ahrefs.api.webAnalytics.sourcesChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`sources_to_chart`	`string`	No	Comma-separated traffic source values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  source?: string | null,
  timestamp?: string | null
}[]

stats

webAnalytics.stats Web Analytics: get visitors, visits, pageviews, bounce rate and session length for a period Risk: read

await corsair.ahrefs.api.webAnalytics.stats({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null
}

topPages

webAnalytics.topPages Web Analytics: list visitors by page Risk: read

await corsair.ahrefs.api.webAnalytics.topPages({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  page?: string | null
}[]

topPagesChart

webAnalytics.topPagesChart Web Analytics: chart visitors by page over time Risk: read

await corsair.ahrefs.api.webAnalytics.topPagesChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`pages_to_chart`	`string`	No	Comma-separated page values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  page?: string | null,
  timestamp?: string | null
}[]

utmParams

webAnalytics.utmParams Web Analytics: list visitors by UTM parameter value Risk: read

await corsair.ahrefs.api.webAnalytics.utmParams({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`order_by`	`string`	No	Order by a metric, as metric:desc or metric:asc.
`limit`	`number`	No	The number of results to return.
`utm_param`	`utm_source \| utm_medium \| utm_campaign \| utm_term \| utm_content`	Yes	The UTM parameter to group visitors by.

Output

Name	Type	Required	Description
`stats`	`object[]`	Yes	—

stats full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  utm_param?: string | null
}[]

utmParamsChart

webAnalytics.utmParamsChart Web Analytics: chart visitors by UTM parameter value over time Risk: read

await corsair.ahrefs.api.webAnalytics.utmParamsChart({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	The ID of the Ahrefs project that has Web Analytics installed.
`from`	`string`	No	Start of the period, e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
`to`	`string`	No	End of the period, in the same format as from.
`where`	`string`	No	Filter expression as a JSON string over dimensions and metrics; see the Ahrefs API docs.
`output`	`json`	No	—
`granularity`	`hourly \| daily \| weekly \| monthly`	Yes	The time step between chart points.
`utm_param`	`utm_source \| utm_medium \| utm_campaign \| utm_term \| utm_content`	Yes	The UTM parameter to group visitors by.
`utm_params_to_chart`	`string`	No	Comma-separated UTM parameter value values to chart; the top ones are charted when omitted.

Output

Name	Type	Required	Description
`points`	`object[]`	Yes	—

points full type

{
  visitors?: number | string | null,
  visits?: number | string | null,
  pageviews?: number | string | null,
  session_bounce_rate?: number | null,
  avg_session_duration_sec?: number | null,
  avg_session_length?: number | null,
  avg_page_visit_duration_sec?: number | null,
  entries?: number | string | null,
  exits?: number | string | null,
  exit_rate?: number | null,
  utm_param?: string | null,
  timestamp?: string | null
}[]

​Batch Analysis

​analyze

​Brand Radar

​aiResponses

​aiResponsesEntities

​citationsHistoryEntities

​citationsOverviewEntities

​citedDomains

​citedDomainsEntities

​citedPages

​citedPagesEntities

​impressionsHistory

​impressionsHistoryEntities

​impressionsOverview

​impressionsOverviewEntities

​mentionsHistory

​mentionsHistoryEntities

​mentionsOverview

​mentionsOverviewEntities

​sovHistory

​sovHistoryEntities

​sovOverview

​sovOverviewEntities

​Content Helper

​topics

​Gsc

​anonymousQueries

​ctrByPosition

​keywordHistory

​keywords

​metricsByCountry

​pageHistory

​pages

​pagesHistory

​performanceByDevice

​performanceByPosition

​performanceHistory

​positionsHistory

​Keywords Explorer

​matchingTerms

​overview

​relatedTerms

​searchSuggestions

​volumeByCountry

​volumeHistory

​Management

​addBrandRadarPrompts

​addKeywordListKeywords

​addProjectCompetitors

​addProjectKeywords

​addProjectKeywordTags

​brandRadarPrompts

​brandRadarReports

​createBrandRadarReport

​createKeywordList

​createProject

​deleteBrandRadarPrompts

​deleteKeywordListKeywords

​deleteKeywordLists

​deleteProjectCompetitors

​deleteProjectKeywords

​deleteProjectKeywordTags

​deleteProjects

​keywordListKeywords

​keywordLists

​locations

​projectCompetitors

​projectKeywords

​projects

​updateBrandRadarPrompts

​updateBrandRadarReport

​updateProject

​Public

​crawlerIpRanges

​crawlerIps

​domainRatingFree

​domainRatingFreeBatch

​domainRatingTopDomains

​Rank Tracker

​competitorsDomains

Batch Analysis

analyze

Brand Radar

aiResponses

aiResponsesEntities

citationsHistoryEntities

citationsOverviewEntities

citedDomains

citedDomainsEntities

citedPages

citedPagesEntities

impressionsHistory

impressionsHistoryEntities

impressionsOverview

impressionsOverviewEntities

mentionsHistory

mentionsHistoryEntities

mentionsOverview

mentionsOverviewEntities

sovHistory

sovHistoryEntities

sovOverview

sovOverviewEntities

Content Helper

topics

Gsc

anonymousQueries

ctrByPosition

keywordHistory

keywords

metricsByCountry

pageHistory

pages

pagesHistory

performanceByDevice

performanceByPosition

performanceHistory

positionsHistory

Keywords Explorer

matchingTerms

overview

relatedTerms

searchSuggestions

volumeByCountry

volumeHistory

Management

addBrandRadarPrompts

addKeywordListKeywords

addProjectCompetitors

addProjectKeywords

addProjectKeywordTags

brandRadarPrompts

brandRadarReports

createBrandRadarReport

createKeywordList

createProject

deleteBrandRadarPrompts

deleteKeywordListKeywords

deleteKeywordLists

deleteProjectCompetitors

deleteProjectKeywords

deleteProjectKeywordTags

deleteProjects

keywordListKeywords

keywordLists

locations

projectCompetitors

projectKeywords

projects

updateBrandRadarPrompts

updateBrandRadarReport

updateProject

Public

crawlerIpRanges

crawlerIps

domainRatingFree

domainRatingFreeBatch

domainRatingTopDomains

Rank Tracker

competitorsDomains