Method description

Retrieve the cost of a ranking check.
Get structured results grouped out by a project owner.

This method can't be applied to the archived projects.

Method parameters

Parameter Type Description Default
filters array filters
of projects
Filter projects by
regions_indexes array(int) Region index (filter)
groups_ids array(int) Group 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 TOP20
  • 3 - snapshots TOP30
  • 5 - snapshots TOP50
  • 9 - snapshots TOP100
Project settings value
keyword_id int

keyword ID (filter)

  • can't be used for a bulk update
  • regions_indexes required
  • groups_ids ignored
apply_discount int boolean Return amount less a discount 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
%userId% object Object stores ranking check cost for a selected user
projectsIds array(int) selected projects id
price float Ranking check cost