Competitor Landscape Data

Chart

Endpoint

GET https://art.ayima.com/api/reports/{reportId}/mi/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	🚫
normalize_mi_scale	Boolean	If the data should be normalised (not go over 100%)	🚫

Response

{
  "series": [
    {
      "label": "...",
      "color": "...",
      "estimated_traffic": [],
      "share_of_traffic": [],
      "share_of_voice": [],
      "relative_score": [],
      "estimated_traffic_human": []
    }
  ],
  "categories": [],
  "categories_formatted": [],
  "annotations": [],
  "range": {
    "estimated_traffic": {
      "min": "...",
      "max": "..."
    },
    "share_of_traffic": {
      "min": "...",
      "max": "..."
    },
    "share_of_voice": {
      "min": "...",
      "max": "..."
    },
    "relative_score": {
      "min": "...",
      "max": "..."
    }
  },
  "date_range_string": "..."
}

Table

Endpoint

GET https://art.ayima.com/api/reports/{reportId}/mi/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: 'host', 'domain', 'change_estimated_traffic', 'change_estimated_traffic', 'change_share_of_traffic', 'estimated_traffic', 'first_estimated_traffic', 'share_of_traffic', 'first_share_of_traffic', 'last_estimated_traffic', 'last_share_of_traffic', 'share_of_voice', 'first_share_of_voice', 'last_share_of_voice', 'change_share_of_voice'	✅
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": [
    {
      "change_estimated_traffic": "...",
      "change_share_of_traffic": "...",
      "change_share_of_voice": "...",
      "domain": "...",
      "estimated_traffic": "...",
      "first_estimated_traffic": "...",
      "first_share_of_traffic": "...",
      "first_share_of_voice": "...",
      "last_estimated_traffic": "...",
      "last_share_of_traffic": "...",
      "last_share_of_voice": "...",
      "share_of_traffic": "...",
      "share_of_voice": "...",
      "is_brand": "...",
      "is_competitor": "...",
      "estimated_traffic_human": "...",
      "first_estimated_traffic_human": "...",
      "last_estimated_traffic_human": "...",
      "change_estimated_traffic_human": "..."
    }
  ],
  "pagination": {
    "count": "...",
    "current": "...",
    "items": "...",
    "page_length": "..."
  }
}