feat: introduce organic keywords for ahrefs client and top keyword in top pages #257
Conversation
dzehnder
requested review from
ekremney,
solaris007,
iuliag and
AndreiAlexandruParaschiv
|
This PR will trigger a minor release when merged. |
| @@ -174,4 +174,28 @@ export default class AhrefsAPIClient { | |||
|
|
|||
| return this.sendRequest('/site-explorer/metrics-history', queryParams); | |||
| } | |||
|
|
|||
| async getOrganicKeywords(url, country = 'us', keywordFilter = [], limit = 200) { | |||
There was a problem hiding this comment.
missing input parameter validation
There was a problem hiding this comment.
Do we need a country, what if this is a global site?
I wouldn't set the default to be us, but rather none.
There was a problem hiding this comment.
yes the country is mandatory for this Ahrefs request because keywords are country specific.
For the Google API, this is not the case, there you can get them across all countries, which in some cases also creates confusing results (in this case needs to be filtered by subdomain or path, which results ultimately in the same issue).
I see two options for this:
- we extract the country from either url or hreflang tag
- we collect the keywords from the top-pages (already suggested by @iuliag through other channels). This might have some disadvantages as top-pages differ from keyword rankings. On the other hand, we can save an additional Ahrefs API request. We could also increase the limit in this case to import maybe top 2k pages for better accuracy
|
I'm thinking we might also want to try with just adding |
| @@ -174,4 +174,28 @@ export default class AhrefsAPIClient { | |||
|
|
|||
| return this.sendRequest('/site-explorer/metrics-history', queryParams); | |||
| } | |||
|
|
|||
| async getOrganicKeywords(url, country = 'us', keywordFilter = [], limit = 200) { | |||
There was a problem hiding this comment.
Do we need a country, what if this is a global site?
I wouldn't set the default to be us, but rather none.
dzehnder
changed the title
# [@adobe/spacecat-shared-ahrefs-client-v1.3.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-ahrefs-client-v1.2.6...@adobe/spacecat-shared-ahrefs-client-v1.3.0) (2024-06-19) ### Features * introduce organic keywords for ahrefs client and top keyword in top pages ([#257](#257)) ([371f1c4](371f1c4))
|
🎉 This PR is included in version @adobe/spacecat-shared-ahrefs-client-v1.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
# [@adobe/spacecat-shared-data-access-v1.30.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.29.2...@adobe/spacecat-shared-data-access-v1.30.0) (2024-06-19) ### Features * introduce organic keywords for ahrefs client and top keyword in top pages ([#257](#257)) ([371f1c4](371f1c4))
|
🎉 This PR is included in version @adobe/spacecat-shared-data-access-v1.30.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
In context for SITES-22601 (auto fix broken backlinks), we need access to the keywords of a page to determine the best possible alternate url (as suggested by research)
Cost estimation for the API consumption:
Request per page:
Worst Case:
Each row in the query costs 12 Units (sum_traffic: 10, keyword: 1, best_position_url: 1)
Using a limit of 200 rows per request: 2400 Units (12 x 200).
For 200 broken backlinks: 480k Units (2400 x 200)
For import:
How many keywords should be imported?
For example, page with 20k keywords (with traffic):
Getting all keywords: 240k Units (12 x 20 000)
Getting top 2k keywords: 24k Units (12 x 2000)