Reports

Get all

Endpoint

GET https://art.ayima.com/api/reports

parameters

name	type	description	required
page_size	Integer	The number of reports to return on each call.	🚫
col_order	String	The property used to order the reports. Options are: 'name', is_favourite', 'tracked_keywords' and 'created_at'.	🚫
col_order_dir	String	Ordering direction- either 'asc' or 'desc'.	🚫
search_engines	Array	An array of search engine ID's to filter.	🚫
teams	Array	An array of team ID's to filter.	🚫
search	String	A search filter to be applied to the report name only.	🚫
keyword_filter	String	A search filter to only bring reports containing a specific keyword.	🚫
parentUuid	String	A ID to the parent report if you want to pull child report /group keywords from a report.	🚫

Response

{
  "data": [
        {
            "id": "...",
            "secret": "...",
            "name": "...",
            "is_building": "...",
            "build_reason": "...",
            "build_percent": "...",
            "back_fill_from": "...",
            "original_name": "...",
            "gs_data_studio_enabled": "...",
            "gs_data_studio_secret": "...",
            "group_stats_as": "...",
            "visible_to_client": "...",
.....

Get singular

Endpoint

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

Parameters

name	type	description	required
store	Boolean	Indication if the reports 'last_viewed' should	🚫

Response

{
    "data": {
        "id": "...",
        "name": "...",
        "url": "...",
        "host": "...",
        "domain": "...",
        "is_competitor": "...",
        "reports": "...",
        "created_at": "..."
    }
}

Create

Endpoint

PUT https://art.ayima.com/api/organisations/{organisationId}/teams/{teamId}/reports

parameters

name	type	description	required
bucket_id	String	The ID of an existing bucket if preferred over creating a new bucket.	string
bucket_name	String	The name of the bucket to create	Required if bucket_id is not specified and creating a new bucket.
search_engine_ids	Array	The search engine ID to use for the bucket. NOTE: if multiple are provided multiple buckets/reports will be created.	Required if bucket_id is not specified and creating a new bucket.
keywords	String	A CSV formatted value for each keyword/search volume to import. for example: "keyword,20\nanotherkeyword,30"	Required if bucket_id is not specified and creating a new bucket.
tracking_interval	Integer	Tracking interval of the bucket: 1 daily, 2: weekly, 3: monthly.	Required if bucket_id is not specified.
track_till	Date	A Y-m-d formatted date to limit the tracking date on the bucket.	🚫
backfill	Date	A Y-m-d formatted date to backfill the bucket if required.	🚫
name	String	The name of the report	✅
visible_to_client	Boolean	Indication if the report should be visible to the client.	✅
website_id	String	The website ID to be used for this report.	✅
group_stats_by	String	How to group the stats in report overview- either 'DOMAIN' or 'HOSTNAME'	✅
show_ranking_positions_tab	Boolean	Inidicates if the ranking position tab should be visible	✅
show_ranking_distribution_tab	Boolean	Inidicates if the ranking distribution tab should be visible	✅
show_mi_tab	Boolean	Inidicates if the competitor landscape tab should be visible	✅
show_mi_analysis	Boolean	Inidicates if the competitor analysis tab should be visible	✅
show_backlinks_tab	Boolean	Inidicates if the backlinks tab should be visible	✅
show_keywords_tab	Boolean	Inidicates if the tracked keywords tab should be visible	✅
show_url_analysis_tab	Boolean	Inidicates if the URL analsysis tab should be visible	✅
show_grouped_keywords_tab	Boolean	Inidicates if the Grouped keywords tab should be visible	✅

Response

{
    "created": true
}

Update

Endpoint

POST https://art.ayima.com/api/reports/{reportId}

parameters

name	type	description	required
bucket_id	String	The ID of the bucket.	string
name	String	The name of the report	✅
visible_to_client	Boolean	Indication if the report should be visible to the client.	✅
website_id	String	The website ID to be used for this report.	✅
group_stats_by	String	How to group the stats in report overview- either 'DOMAIN' or 'HOSTNAME'	✅
show_ranking_positions_tab	Boolean	Inidicates if the ranking position tab should be visible	✅
show_ranking_distribution_tab	Boolean	Inidicates if the ranking distribution tab should be visible	✅
show_mi_tab	Boolean	Inidicates if the competitor landscape tab should be visible	✅
show_mi_analysis	Boolean	Inidicates if the competitor analysis tab should be visible	✅
show_backlinks_tab	Boolean	Inidicates if the backlinks tab should be visible	✅
show_keywords_tab	Boolean	Inidicates if the tracked keywords tab should be visible	✅
show_url_analysis_tab	Boolean	Inidicates if the URL analsysis tab should be visible	✅
show_grouped_keywords_tab	Boolean	Inidicates if the Grouped keywords tab should be visible	✅
team_id	String	The ID of the team this report belongs to.	✅
override_bucket_creation_date	Data	A Y-m-d formatted date overiding the bucket creation date. Used to change date range min date	🚫
ctrs	Array(30)	An array of custom click through rate values to be used on the report.	✅

Response

{
    "success": true
}

Report Stats

Endpoint

GET https://art.ayima.com/api/reports/stats

Parameters

name	type	description	required
from	Date	The start date range for result data	✅
to	Date	The end date range for result data	✅

Response

{
    "last_updated": "...",
    "avg_position": "...",
    "avg_share_of_traffic": "...",
    "estimated_traffic": "...",
    "estimated_traffic_human": "...",
    "keywords_count": "...",
    "ranked_keyword_count": "...",
    "non_ranked_keyword_count": "...",
    "ranked_keyword_coverage": "...",
    "non_ranked_keyword_coverage": "..."
}

Get Keywords

Endpoint

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

parameters

name	type	description	required
page	int	The current page of the paginated data.	string
page_size	int	The number of items to return on each page.	✅
col_order	Boolean	Sorting order of the keywords, either 'keyword' or 'search_volume'	✅
col_order_dir	String	The direction of ordering, either 'asc' or 'desc'	✅

Response

{
    "data": [
        {
            "keyword": "...",
            "search_volume": "..."
        }
    ],
    "pagination": {
        "count": "...",
        "current": "...",
        "items": "...",
        "page_length": "..."
    }
}

Toggle Favourite

Endpoint

POST https://art.ayima.com/api/reports/{reportId}/favourite

parameters

N/A

Response

{
    "favourited": true|false
}

Delete

Endpoint

DELETE https://art.ayima.com/api/reports/{reportId}

parameters

N/A

Response

{
    "deleted": true
}