get/positions_2/summary
Method description
Pull summary data of two compared dates in a selected project.
Method parameters
Parameter | Type | Description | Default |
Mandatory | |||
---|---|---|---|
project_id | int | project ID | |
region_index | int | Region index | |
dates | array(date, date) | Two dates to be compared to create a summary, the difference between these dates is calculated | |
Additional | |||
competitor_id | int |
ID of a competitor added in the project settings. If set, the method returns a summary for a competitor. |
|
only_exists_first_date | boolean | Use the keywords that existed in the project on the both dates | 0 |
show_dynamics | boolean | Add keyword ranking dynamics (improved/dropped) | 0 |
show_tops | boolean | Add distribution across TOPs | 0 |
show_avg | boolean | Add Average position | 0 |
show_visibility | boolean | Add Visibility | 0 |
Returned data
Parameter | Type | Description |
result (object) | ||
---|---|---|
dates | array(date,date) | Dates used to create a summary |
Dynamics (if show_dynamics = 1) | ||
dynamics | object | Ranking dynamics (keyword count, rankings that improved/didn't change/dropped) Object properties:
|
Distribution across TOPs (if show_tops = 1) | ||
tops | object |
The number of keyword in TOPs Object properties:
|
tops_dynamics | object |
Ranking dynamics in TOPs (rankings advanced/rankings dropped) Object properties: see tops description. |
Average position (if show_avg = 1) | ||
avgs | array | Average position |
avg_dynamic | int | Average position dynamics (rankings advanced/rankings dropped) |
Visibility (if show_visibility = 1) | ||
visibilities | array | Visibility |
visibility_dynamic | int | Visibility dynamics (rankings advanced/rankings dropped) |