Ranking Position Data

Chart

Endpoint

GET https://art.ayima.com/api/reports/{reportId}/ranking/chart

parameters

name	type	description	required
from	Date	The start date range for result data	✅
to	String	The end date range for result data	✅
format	String	The format to return the data in. Options are: 'json' (default),'csv','xlsx','xls','html','tsv','ods'	✅
plot_by	String	How to group the data. Options are: 'daily','weekly','quarterly','monthly','yearly'	✅
group_by	String	If the data should be grouped using domains or hostname. Options are: 'hostname', 'domain'	✅
store	String	String value indicating the last viewed record is updated. Value can be 'true' or 'false' NOT Boolen	🚫
keywords	Array	A array list of keywords to filter the returned results	🚫
domain	String	Competitor domain to pull results for	🚫
hostname	String	Competitor hostname to pull results for	🚫

Response

{
   "series": [
     {
       "keyword": "...",
       "search_volume": "...",
       "interpolated": "...",
       "interpolated_index": "...",
       "color": "...",
       "rankings": [],
       "searchVolumes": [],
       "urls": [],
       "url_changes": [],
       "dates": [
         {
           "timestamp": "...",
           "search_volume": "...",
           "position": "...",
           "url": "...",
           "url_change": "..."
         }
       ]
     }
   ],
   "categories": [],
   "categories_formatted": [],
   "annotations": [
     {
       "id": "...",
       "type": "...",
       "title": "...",
       "description": "...",
       "date": "...",
       "plot_date": "2020-10-02"
     }
   ],
   "range": {},
   "date_range_string": "...",
   "plot_by": "...",
   "has_ranking_data": "...",
   "response_data": [
     {
       "date": "...",
       "exist": "...",
       "keyword": "...",
       "position": "...",
       "positions": [],
       "search_volume": "...",
       "urls": []
     }
   ]
 }

Table

Endpoint

GET https://art.ayima.com/api/reports/{reportId}/ranking/table

parameters

name	type	description	required
from	Date	The start date range for result data	✅
to	Date	The end date range for result data	✅
page_number	int	The current page of the paginated data.	✅
page_size	int	The number of items to return on each page.	✅
group_by	String	If the data should be grouped using domains or hostname. Options are: 'hostname', 'domain'	✅
col_order	Boolean	Sorting order, options are: 'keyword', 'search_volume', 'nr_unique_urls', 'last', 'difference', 'highest', 'lowest', 'median', 'first'	✅
col_order_dir	String	The direction of ordering, either 'asc' or 'desc'	✅
domain	String	Competitor domain to pull results for	🚫
hostname	String	Competitor hostname to pull results for	🚫

Response

{
  "data": [
    {
      "difference": "...",
      "exists": "...",
      "first": "...",
      "highest": "...",
      "keyword": "...",
      "last": "...",
      "lowest": "...",
      "mean": "...",
      "median": "...",
      "nr_unique_urls": "...",
      "search_volume": "...",
      "unique_urls": [],
      "volatility": "...",
      "search_volume_human": "..."
    }
  ],
  "pagination": {
    "count": "...",
    "current": "...",
    "items": "...",
    "page_length": "..."
  }
}