get/positions_2/checker/price
Method description
Retrieve the cost of a keyword ranking check.
Get structured results grouped out by a project owner.
This method cannot be applied to the archived projects.
Method parameters
Parameter |
Type |
Description |
Default |
Mandatory |
filters |
array filters
of projects
|
Filter projects by |
|
Additional |
regions_indexes |
array(int) |
Region index (filter) |
|
folders_ids |
array(int) |
Folder ids (filter) |
|
folders_ids_depth |
int boolean |
Check subfolders when filter by folder ID applied |
0 |
groups_ids |
array(int) |
Groups ids (filter) |
|
do_snapshots |
enum(0, 2, 3, 5, 9) |
Snapshots tool depth (has higher priority than the project settings).
Available options:
- 0 - do not collect snapshots
- 2 - snapshots TOP-20
- 3 - snapshots TOP-30
- 5 - snapshots TOP-50
- 9 - snapshots TOP-100
|
Project settings value |
keyword_id |
int |
keyword ID (filter)
- cannot be used in a bulk update
- regions_indexes mandatory
- groups_ids ignored
|
|
apply_discount |
int boolean |
Applies discount and returns an amountt |
1 |
View in API explorer
Returned data
Parameter |
Type |
Description |
result (object) |
pricesByUsers |
object |
Object stores ranking check cost grouped out by a project owner
|
result.pricesByUsers |
%userId% |
object |
Object stores ranking check cost for a selected user
|
result.pricesByUsers.%userId% |
projectsIds |
array(int) |
selected project IDs |
price |
float |
Ranking check cost |