Ranking Distribution Data

Chart

Endpoint

GET https://art.ayima.com/api/reports/{reportId}/distribution/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	🚫
domain	String	Competitor domain to pull results for	🚫
hostname	String	Competitor hostname to pull results for	🚫

Response

{
  "series": {
    "totals": [],
    "percentage": [
      {
        "name": "01-05",
        "data": []
      },
      {
        "name": "06-10",
        "data": []
      },
      {
        "name": "11-20",
        "data": []
      },
      {
        "name": "21-50",
        "data": []
      },
      {
        "name": "50+",
        "data": []
      }
    ],
    "count": [
      {
        "name": "01-05",
        "data": []
      },
      {
        "name": "06-10",
        "data": []
      },
      {
        "name": "11-20",
        "data": []
      },
      {
        "name": "21-50",
        "data": []
      },
      {
        "name": "50+",
        "data": []
      }
    ]
  },
  "categories": [],
  "categories_formatted": [],
  "category_ranges": [],
  "annotations": [],
  "date_range_string": "..."
}

Table

Endpoint

GET https://art.ayima.com/api/reports/{reportId}/distribution/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	🚫
plot_by	String	How to group the data. Options are: 'daily','weekly','quarterly','monthly','yearly'	✅

Response

{
  "current_page": "...",
  "data": [
    {
      "label": "...",
      "timestamp": "...",
      "total": "...",
      "01-05": "...",
      "06-10": "...",
      "11-20": "...",
      "21-50": "...",
      "50+": "...",
      "01-05 %": "...",
      "06-10 %":"...",
      "11-20 %": "...",
      "21-50 %": "...",
      "50+ %": "..."
    }
  ],
  "first_page_url": "...",
  "from": "...",
  "last_page": "...",
  "last_page_url": "...",
  "next_page_url": "...",
  "path": "...",
  "per_page": "...",
  "prev_page_url": "...",
  "to": "...",
  "total": "..."
}