Skip to content

PS-261 Extend Tools rankings API for support return optionally available volumes data based on input parameter #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

PS-261 Extend Tools rankings API for support return optionally available volumes data based on input parameter #142

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5bcd8b5
PS-261 add rankings "with-keyword-volume" param to api doc
itch Jan 18, 2022
24e6459
Update source/includes/_rankings.md
itch Jan 19, 2022
0092389
Update source/includes/_rankings.md
itch Jan 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions source/includes/_rankings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,8 @@ Console.WriteLine(response);
"website address"
],
"matched_url": "www.thecenternyc.com",
"serp-screenshot-url": "https://seo-serp-screenshots.s3.amazonaws.com/2016/10/14/14/6daa949323ef54687f41d95500751fd08256bc17.png"
"serp-screenshot-url": "https://seo-serp-screenshots.s3.amazonaws.com/2016/10/14/14/6daa949323ef54687f41d95500751fd08256bc17.png",
"keyword-volume": 1234
},
{
"url": "http://thecenternyc.com/back-pain-nyc/",
Expand All @@ -208,7 +209,8 @@ Console.WriteLine(response);
"website address"
],
"matched_url": "www.thecenternyc.com",
"serp-screenshot-url": "https://seo-serp-screenshots.s3.amazonaws.com/2016/10/14/14/6daa949323ef54687f41d95500751fd08256bc17.png"
"serp-screenshot-url": "https://seo-serp-screenshots.s3.amazonaws.com/2016/10/14/14/6daa949323ef54687f41d95500751fd08256bc17.png",
"keyword-volume": 2345
}
],
"result-types": [
Expand Down Expand Up @@ -377,6 +379,7 @@ telephone | A valid telephone number.
include-secondary-matches | Determines whether or not to include results matched by name, telephone and/or ZIP/postal code. One of yes or no. This should be used in conjunction with the postal and telephone parameters.
listings | Include details of all SERPs returned, not just the matches. Defaults to "no". Accepts "yes" or "no". The default is "no".
screenshots | Determines whether or not to generate SERP screenshots and include the links to those screenshots in the response. Accepts "yes" or "no". The default is "no".
with-keyword-volume | Include keyword volume data in the response. There's an additional charge for this data. Accepts "yes" or "no". The default is "no".

<aside class="notice">
By default we return 5 pages or 50 results (whichever is lower). If you need more than this please contact us. We can increase to a maximum of 10 pages or 100 results on a case by case basis.
Expand Down Expand Up @@ -539,6 +542,7 @@ telephone | A valid telephone number.
include-secondary-matches | Determines whether or not to include results matched by name, telephone and/or ZIP/postal code. One of yes or no. This should be used in conjunction with the postal and telephone parameters.
listings | Include details of all SERPs returned, not just the matches. Defaults to "no". Accepts "yes" or "no". The default is "no".
screenshots | Determines whether or not to generate SERP screenshots and include the links to those screenshots in the response. Accepts "yes" or "no". The default is "no".
with-keyword-volume | Include keyword volume data in the response. There's an additional charge for this data. Accepts "yes" or "no". The default is "no".

<aside class="notice">
By default we return 5 pages or 50 results (whichever is lower). If you need more than this please contact us. We can increase to a maximum of 10 pages or 100 results on a case by case basis.
Expand Down