Ahrefs

Ahrefs is a comprehensive suite of SEO (Search Engine Optimization) tools used by digital marketers and businesses to improve their website's visibility in search engine results.

Categories: Analytics

Type: ahrefs/v1

Connections

Version: 1

Bearer Token

Properties

Name	Label	Type	Description	Required
token	Token	STRING		true

Actions

Get Metrics

Name: getMetrics

Returns metrics from target.

Properties

Name	Label	Type	Description	Required
target	Target	STRING	`The target of the search: a domain or a URL.`	true
date	Date	STRING	`A date to report metrics on in YYYY-MM-DD format.`	true
volume_mode	Volume Mode	STRING Options monthly, average	`The search volume calculation mode: monthly or average. It affects volume, traffic, and traffic value.`	false
protocol	Protocol	STRING Options both, http, https	`The protocol of your target`	false
output	Output	STRING Options json, csv, xml, php	`The output format.`	false
mode	Mode	STRING Options exact, prefix, domain, subdomains	`The search volume calculation mode: monthly or average. It affects volume, traffic, and traffic value.`	false

Example JSON Structure

{
  "label" : "Get Metrics",
  "name" : "getMetrics",
  "parameters" : {
    "target" : "",
    "date" : "",
    "volume_mode" : "",
    "protocol" : "",
    "output" : "",
    "mode" : ""
  },
  "type" : "ahrefs/v1/getMetrics"
}

Output

Type: OBJECT

Properties

Name	Type	Description
metrics	OBJECT Properties {INTEGER(org_keywords), INTEGER(paid_keywords), INTEGER(org_keywords_1_3), INTEGER(org_traffic), INTEGER(org_cost), INTEGER(paid_traffic), INTEGER(paid_cost), INTEGER(paid_pages)}

Output Example

{
  "metrics" : {
    "org_keywords" : 1,
    "paid_keywords" : 1,
    "org_keywords_1_3" : 1,
    "org_traffic" : 1,
    "org_cost" : 1,
    "paid_traffic" : 1,
    "paid_cost" : 1,
    "paid_pages" : 1
  }
}

Get Subscription Information

Name: getSubscriptionInfo

Returns user subscription information.

Example JSON Structure

{
  "label" : "Get Subscription Information",
  "name" : "getSubscriptionInfo",
  "type" : "ahrefs/v1/getSubscriptionInfo"
}

Output

Type: OBJECT

Properties

Name	Type	Description
limits_and_usage	OBJECT Properties {STRING(subscription), STRING(usage_reset_date), INTEGER(units_limit_workspace), INTEGER(units_usage_workspace), INTEGER(units_limit_api_key), INTEGER(units_usage_api_key), STRING(api_key_expiration_date)}

Output Example

{
  "limits_and_usage" : {
    "subscription" : "",
    "usage_reset_date" : "",
    "units_limit_workspace" : 1,
    "units_usage_workspace" : 1,
    "units_limit_api_key" : 1,
    "units_usage_api_key" : 1,
    "api_key_expiration_date" : ""
  }
}

Get Page Content

Name: getPageContent

Returns the content of a page.

Properties

Name	Label	Type	Description	Required
target_url	Target URL	STRING	`The URL of the page to retrieve content for.`	true
project_id	Project ID	STRING	`The unique identifier of the project. Only projects with verified ownership are supported.`	true
select	Select	STRING Options crawl_datetime, page_text, raw_html, rendered_html	`A comma-separated list of columns to return.`	true

Example JSON Structure

{
  "label" : "Get Page Content",
  "name" : "getPageContent",
  "parameters" : {
    "target_url" : "",
    "project_id" : "",
    "select" : ""
  },
  "type" : "ahrefs/v1/getPageContent"
}

Output

Type: OBJECT

Properties

Name	Type	Description
page-content	OBJECT Properties {STRING(crawl_datetime), STRING(page_text), STRING(raw_html), STRING(rendered_html)}

Output Example

{
  "page-content" : {
    "crawl_datetime" : "",
    "page_text" : "",
    "raw_html" : "",
    "rendered_html" : ""
  }
}

On this page