get/positions_2/summary_chart
Method description
Use the method to return metrics coordinates for a graph with the following axes: Date/Value.
There are 3 available graphs:
- Date/TOP segments (several values, one for every TOP segment)
- Date/Visibility
- Date/Average position
Method parameters
Parameter | Type | Description | Default |
Mandatory | |||
---|---|---|---|
project_id | int | project ID | |
region_index | int | Region index | |
dates | array of date |
Custom dates of keyword ranking checks (dates is mandatory, if date1 or date2 are not specified) |
|
date1, date2 | date |
The first and the last date of a period (date1 and date2 are mandatory, if dates isn't specified) |
|
Additional | |||
competitor_id | array |
IDs of competitors added in the project settings. If not specified, competitors visibility and average position are returned. |
|
type_range | enum(0, 1, 2, 3, 4, 5, 6, 7, 100) |
Period Available options:
|
2 |
only_exists_first_date | boolean | Add keywords with checks on all dates within a period | 0 |
show_tops | boolean | Add TOPs data | 0 |
show_avg | boolean | Add average position | 0 |
show_visibility | boolean | Add visibility | 0 |
Returned data
Parameter | Type | Description |
result (object) | ||
---|---|---|
dates | array | Custom dates (X axis) |
seriesByProjectsId | object | Coordinates grouped by a project ID |
result.seriesByProjectsId.%projectId% | ||
tops | object |
Number of keywords in TOPs Object properties:
|
avg | array | Average position for dates specified in dates |
visibility | array | Visibility for dates specified in dates |