{
  "description": "Look up public AhrefsTop profiles, competitor rows and top-website rankings.",
  "properties": {
    "domains": {
      "description": "Domains or full URLs (mode=domain/authority/backlinks/traffic/competitors). `www` and non-`www` forms are both tried. Duplicates are removed.",
      "editor": "stringList",
      "prefill": [
        "wikipedia.org"
      ],
      "title": "Domains",
      "type": "array"
    },
    "includeCompetitors": {
      "default": true,
      "description": "Include the top 5 competing websites on the profile (mode=domain).",
      "prefill": false,
      "title": "Include competitors",
      "type": "boolean"
    },
    "includeCountries": {
      "default": true,
      "description": "Include the top 5 traffic countries (mode=domain/traffic).",
      "prefill": false,
      "title": "Include countries",
      "type": "boolean"
    },
    "includeHistory": {
      "default": true,
      "description": "Include monthly traffic, traffic-value and linking-website history (mode=domain/authority/backlinks/traffic).",
      "prefill": false,
      "title": "Include history",
      "type": "boolean"
    },
    "includeKeywords": {
      "default": true,
      "description": "Include the top 5 keywords table (mode=domain/traffic).",
      "prefill": false,
      "title": "Include keywords",
      "type": "boolean"
    },
    "maxItems": {
      "default": 50,
      "description": "Hard cap on emitted rows across all requested domains or ranking pages.",
      "maximum": 1000,
      "minimum": 1,
      "prefill": 1,
      "title": "Max items",
      "type": "integer"
    },
    "mode": {
      "default": "domain",
      "description": "What to fetch. `domain` returns the full public profile; `competitors` returns one row per competitor; `topWebsites` returns the AhrefsTop ranking without needing domains. Legacy values `full`, `authority_only` and `backlinks_only` are accepted and mapped to `domain`, `authority` and `backlinks`.",
      "editor": "select",
      "enum": [
        "domain",
        "authority",
        "backlinks",
        "traffic",
        "competitors",
        "topWebsites",
        "full",
        "authority_only",
        "backlinks_only"
      ],
      "enumTitles": [
        "Full domain profile",
        "Authority (DR and linking sites)",
        "Backlinks (link summary and history)",
        "Traffic (rank, traffic, keywords, countries)",
        "Competitors (one row per competitor)",
        "Top websites ranking",
        "Legacy: full profile",
        "Legacy: authority only",
        "Legacy: backlinks only"
      ],
      "prefill": "domain",
      "title": "Mode",
      "type": "string"
    },
    "topWebsitesCategory": {
      "default": "all",
      "description": "(mode=topWebsites) Category filter. Combine with a country for that country's category ranking.",
      "editor": "select",
      "enum": [
        "all",
        "arts-and-entertainment",
        "autos-and-vehicles",
        "beauty-and-fitness",
        "books-and-literature",
        "business",
        "computers-and-electronics",
        "finance",
        "food-and-drink",
        "games",
        "health",
        "hobbies-and-leisure",
        "home-and-garden",
        "internet-and-telecom",
        "jobs-and-education",
        "law-and-government",
        "news",
        "social-networks",
        "people-and-society",
        "pets-and-animals",
        "real-estate",
        "reference",
        "science",
        "shopping",
        "sports",
        "travel-and-transportation"
      ],
      "enumTitles": [
        "All categories",
        "Entertainment",
        "Vehicles",
        "Beauty & Fitness",
        "Books & Literature",
        "Business & Industrial",
        "Computers & Electronics",
        "Finance",
        "Food & Drink",
        "Games",
        "Health",
        "Hobbies & Leisure",
        "Home & Garden",
        "Internet & Telecom",
        "Jobs & Education",
        "Law & Government",
        "News",
        "Online Communities",
        "People & Society",
        "Pets & Animals",
        "Real Estate",
        "Reference",
        "Science",
        "Shopping",
        "Sports",
        "Travel"
      ],
      "prefill": "all",
      "title": "Top websites category",
      "type": "string"
    },
    "topWebsitesCountry": {
      "default": "worldwide",
      "description": "(mode=topWebsites) Country ranking. `worldwide` uses the global top 1000; any other value uses that country's top 100.",
      "editor": "select",
      "enum": [
        "worldwide",
        "afghanistan",
        "albania",
        "algeria",
        "andorra",
        "angola",
        "antigua-and-barbuda",
        "argentina",
        "armenia",
        "australia",
        "austria",
        "azerbaijan",
        "bahamas",
        "bahrain",
        "bangladesh",
        "belarus",
        "belgium",
        "belize",
        "benin",
        "bhutan",
        "bolivia",
        "bosnia-and-herzegovina",
        "botswana",
        "brazil",
        "brunei-darussalam",
        "bulgaria",
        "burkina-faso",
        "burundi",
        "cambodia",
        "cameroon",
        "canada",
        "cape-verde",
        "central-african-republic",
        "chad",
        "chile",
        "colombia",
        "congo",
        "congo-democratic-republic",
        "costa-rica",
        "cote-divoire",
        "croatia",
        "cyprus",
        "czech-republic",
        "denmark",
        "djibouti",
        "dominican-republic",
        "ecuador",
        "egypt",
        "el-salvador",
        "estonia",
        "ethiopia",
        "fiji",
        "finland",
        "france",
        "gabon",
        "gambia",
        "georgia",
        "germany",
        "ghana",
        "gibraltar",
        "greece",
        "greenland",
        "guadeloupe",
        "guatemala",
        "guernsey",
        "guyana",
        "haiti",
        "honduras",
        "hong-kong",
        "hungary",
        "iceland",
        "india",
        "indonesia",
        "iraq",
        "ireland",
        "isle-of-man",
        "israel",
        "italy",
        "jamaica",
        "japan",
        "jersey",
        "jordan",
        "kazakhstan",
        "kenya",
        "kuwait",
        "kyrgyzstan",
        "lao-peoples-democratic-republic",
        "latvia",
        "lebanon",
        "lesotho",
        "libyan-arab-jamahiriya",
        "liechtenstein",
        "lithuania",
        "luxembourg",
        "madagascar",
        "malawi",
        "malaysia",
        "maldives",
        "mali",
        "malta",
        "mauritius",
        "mexico",
        "moldova",
        "mongolia",
        "montenegro",
        "morocco",
        "mozambique",
        "myanmar",
        "namibia",
        "nepal",
        "netherlands",
        "new-zealand",
        "nicaragua",
        "niger",
        "nigeria",
        "north-macedonia",
        "norway",
        "oman",
        "pakistan",
        "palestine",
        "panama",
        "papua-new-guinea",
        "paraguay",
        "peru",
        "philippines",
        "poland",
        "portugal",
        "puerto-rico",
        "qatar",
        "romania",
        "russian-federation",
        "rwanda",
        "saint-vincent-and-grenadines",
        "saudi-arabia",
        "senegal",
        "serbia",
        "seychelles",
        "sierra-leone",
        "singapore",
        "slovakia",
        "slovenia",
        "somalia",
        "south-africa",
        "korea",
        "spain",
        "sri-lanka",
        "suriname",
        "sweden",
        "switzerland",
        "taiwan",
        "tajikistan",
        "tanzania",
        "thailand",
        "timor-leste",
        "togo",
        "trinidad-and-tobago",
        "tunisia",
        "turkey",
        "turkmenistan",
        "uganda",
        "ukraine",
        "united-arab-emirates",
        "united-kingdom",
        "united-states",
        "uruguay",
        "uzbekistan",
        "venezuela",
        "vietnam",
        "virgin-islands-us",
        "zambia",
        "zimbabwe"
      ],
      "enumTitles": [
        "Worldwide",
        "Afghanistan",
        "Albania",
        "Algeria",
        "Andorra",
        "Angola",
        "Antigua And Barbuda",
        "Argentina",
        "Armenia",
        "Australia",
        "Austria",
        "Azerbaijan",
        "Bahamas",
        "Bahrain",
        "Bangladesh",
        "Belarus",
        "Belgium",
        "Belize",
        "Benin",
        "Bhutan",
        "Bolivia",
        "Bosnia And Herzegovina",
        "Botswana",
        "Brazil",
        "Brunei Darussalam",
        "Bulgaria",
        "Burkina Faso",
        "Burundi",
        "Cambodia",
        "Cameroon",
        "Canada",
        "Cape Verde",
        "Central African Republic",
        "Chad",
        "Chile",
        "Colombia",
        "Congo",
        "Congo, Democratic Republic of the",
        "Costa Rica",
        "Cote D'Ivoire",
        "Croatia",
        "Cyprus",
        "Czech Republic",
        "Denmark",
        "Djibouti",
        "Dominican Republic",
        "Ecuador",
        "Egypt",
        "El Salvador",
        "Estonia",
        "Ethiopia",
        "Fiji",
        "Finland",
        "France",
        "Gabon",
        "Gambia",
        "Georgia",
        "Germany",
        "Ghana",
        "Gibraltar",
        "Greece",
        "Greenland",
        "Guadeloupe",
        "Guatemala",
        "Guernsey",
        "Guyana",
        "Haiti",
        "Honduras",
        "Hong Kong",
        "Hungary",
        "Iceland",
        "India",
        "Indonesia",
        "Iraq",
        "Ireland",
        "Isle of Man",
        "Israel",
        "Italy",
        "Jamaica",
        "Japan",
        "Jersey",
        "Jordan",
        "Kazakhstan",
        "Kenya",
        "Kuwait",
        "Kyrgyzstan",
        "Lao People's Democratic Republic",
        "Latvia",
        "Lebanon",
        "Lesotho",
        "Libyan Arab Jamahiriya",
        "Liechtenstein",
        "Lithuania",
        "Luxembourg",
        "Madagascar",
        "Malawi",
        "Malaysia",
        "Maldives",
        "Mali",
        "Malta",
        "Mauritius",
        "Mexico",
        "Moldova",
        "Mongolia",
        "Montenegro",
        "Morocco",
        "Mozambique",
        "Myanmar",
        "Namibia",
        "Nepal",
        "Netherlands",
        "New Zealand",
        "Nicaragua",
        "Niger",
        "Nigeria",
        "North Macedonia",
        "Norway",
        "Oman",
        "Pakistan",
        "Palestine, State of",
        "Panama",
        "Papua New Guinea",
        "Paraguay",
        "Peru",
        "Philippines",
        "Poland",
        "Portugal",
        "Puerto Rico",
        "Qatar",
        "Romania",
        "Russian Federation",
        "Rwanda",
        "Saint Vincent And Grenadines",
        "Saudi Arabia",
        "Senegal",
        "Serbia",
        "Seychelles",
        "Sierra Leone",
        "Singapore",
        "Slovakia",
        "Slovenia",
        "Somalia",
        "South Africa",
        "Korea",
        "Spain",
        "Sri Lanka",
        "Suriname",
        "Sweden",
        "Switzerland",
        "Taiwan",
        "Tajikistan",
        "Tanzania",
        "Thailand",
        "Timor-Leste",
        "Togo",
        "Trinidad And Tobago",
        "Tunisia",
        "Turkey",
        "Turkmenistan",
        "Uganda",
        "Ukraine",
        "United Arab Emirates",
        "United Kingdom",
        "United States",
        "Uruguay",
        "Uzbekistan",
        "Venezuela",
        "Vietnam",
        "Virgin Islands, U.S.",
        "Zambia",
        "Zimbabwe"
      ],
      "prefill": "worldwide",
      "title": "Top websites country",
      "type": "string"
    },
    "topWebsitesPage": {
      "default": 1,
      "description": "(mode=topWebsites) Starting global ranking page (1 = ranks 1-100, 10 = ranks 901-1000). Country, category and trending rankings expose one page only.",
      "maximum": 10,
      "minimum": 1,
      "prefill": 1,
      "title": "Top websites page",
      "type": "integer"
    },
    "topWebsitesRanking": {
      "default": "ranking",
      "description": "(mode=topWebsites) Position ranking or the monthly trending up/down list.",
      "editor": "select",
      "enum": [
        "ranking",
        "trending_up",
        "trending_down"
      ],
      "enumTitles": [
        "Ranking",
        "Trending up",
        "Trending down"
      ],
      "prefill": "ranking",
      "title": "Top websites ranking type",
      "type": "string"
    }
  },
  "required": [
    "mode"
  ],
  "schemaVersion": 1,
  "title": "Ahrefs Domain Rating, Backlinks & Traffic Lookup Input",
  "type": "object"
}
