Manage columns 
Manage columns 
Column save changes Added columns Column settings Delete columns No columns added
Advanced options
OK
Select locations 
OKClose
Change language settings to use Topvisor in your preferred language. You can select and set a preferred language later in the Account settings. Change language settings to use Topvisor in your preferred language. ru Русский Apply
Cancel All tickets Open Closed
Create ticket
Results: 0
Select a ticket or create a new one,
to contact Customer Support Please describe the problem or ask a question
We will get back to you shortly
Reopen ticket

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:

  • 0 - entire period
  • 1 - updates only
  • 2 - period up to 31 dates
  • 3 - two dates
  • 4 - one date
  • 5 - last date of each month
  • 6 - dates in equal intervals
  • 7 - two last dates of rank checking
  • 100 - custom dates (use with the dates parameter only)
 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

Посмотреть в API Explorer

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:

  • {NN}_{NN} - TOP segments. By default, the following TOP segments are returned:
    • 1_10 - TOP10
    • 11_30 - TOP11-30
    • 31_50 - TOP31-50
    • 51_100 - TOP51-100
    • 101_10000 - TOP100+
  • all - total sum in all TOPs
avg array Average position for dates specified in dates
visibility array Visibility for dates specified in dates

FAQ