get/positions_2/summary
Method description
Pull summary data for two compared dates of a selected project.
Method parameters
| Parameter | Type | Description | Default |
| Required | |||
|---|---|---|---|
| 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 boolean |
ID of a competitor added in the project settings. If set, the method returns a summary for a competitor. |
0 |
| only_exists_first_date | int boolean | Use the keywords that existed on the both dates only | 0 |
| show_dynamics | int boolean | Include ranking dynamics (improved/dropped) | 0 |
| show_tops | int boolean | Include a distribution across TOPs | 0 |
| show_avg | int boolean | Include Average position | 0 |
| show_visibility | int boolean | Include 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 | Rankings 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) |