Annotations

Annotations in the ART system can be created and set against a specific organisation, specific organisational team or globally.

Global Annotations

Get global annotations

Endpoint

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

parameters

name	type	description	required
size	Integer	The number of annotations to show on each page	🚫
col	String	The column to use for sorting. Options are: 'title', 'description', 'date', 'type', 'is_priority', show_in_mi', 'show_in_ranking', 'show_in_url' and 'show_in_distribution'	🚫
col_order_dir	Boolean	If true, sorts data ascendingly, otherwise descendingly	🚫
from	Date	The start date range for result data	🚫
to	String	The end date range for result data	🚫
page	Integer	The current results pages being viewed	🚫

Response

{
   "data": [
        {
            "id": "...",
            "ico": "...",
            "type": "...",
            "title": "...",
            "description": "...",
            "description_raw": "...",
            "type_raw": "...",
            "date": "...",
            "is_global": "...",
            "is_priority": "...",
            "show_in_mi": "...",
            "show_in_ranking": "...",
            "show_in_url": "...",
            "show_in_distribution": "...",
            "created_at": "..."
        }
   ],
    "meta": {
        "pagination": {
            "total": "...",
            "count": "...",
            "per_page": "...",
            "current_page": "...",
            "total_pages": "...",
            "links": {
                "previous": "...",
                "next": "..."
            }
        }
    }
 }

Create global annotation

Endpoint

POST https://art.ayima.com/api/annotations

parameters

name	type	description	required
date	Integer	The date of the annotation event.	✅
type	String	The annotation event type. Options are 'GOOGLE_ALGORITHM', 'COMMENT', 'LINK_BUILT' and 'WEBSITE_UPDATE'	✅
title	String	The title for the annotation	✅
description	String	The description for the annotation	✅
visibility	Array	An array indication for which charts the annotation will be visible. Accepts one or more options of 'mi', 'ranking', 'url' and 'distribution' (competitor landscape, ranking position, URL anaylsis and Distribution respectively)	✅

Response

{
   "created": true
 }

Update global annotation

Endpoint

PUT https://art.ayima.com/api/annotations/{annotationId}

parameters

name	type	description	required
date	Integer	The date of the annotation event.	✅
type	String	The annotation event type. Options are 'GOOGLE_ALGORITHM', 'COMMENT', 'LINK_BUILT' and 'WEBSITE_UPDATE'	✅
title	String	The title for the annotation	✅
description	String	The description for the annotation	✅
visibility	Array	An array indication for which charts the annotation will be visible. Accepts one or more options of 'mi', 'ranking', 'url' and 'distribution' (competitor landscape, ranking position, URL anaylsis and Distribution respectively)	✅

Response

{
   "updated": true
 }

Delete global annotation

Endpoint

DELETE https://art.ayima.com/api/annotations/{annotationId}

parameters

N/A

Response

{
   "deleted": true
 }

Organisation annotations

Get organisation annotation

Endpoint

GET https://art.ayima.com/api/organisations/{organisationId}/annotations

parameters

name	type	description	required
size	Integer	The number of annotations to show on each page	🚫
col	String	The column to use for sorting. Options are: 'title', 'description', 'date', 'type', 'is_priority', show_in_mi', 'show_in_ranking', 'show_in_url' and 'show_in_distribution'	🚫
col_order_dir	Boolean	If true, sorts data ascendingly, otherwise descendingly	🚫
from	Date	The start date range for result data	🚫
to	String	The end date range for result data	🚫
page	Integer	The current results pages being viewed	🚫

Response

{
   "data": [
        {
            "id": "...",
            "ico": "...",
            "type": "...",
            "title": "...",
            "description": "...",
            "description_raw": "...",
            "type_raw": "...",
            "date": "...",
            "is_global": "...",
            "is_priority": "...",
            "show_in_mi": "...",
            "show_in_ranking": "...",
            "show_in_url": "...",
            "show_in_distribution": "...",
            "created_at": "..."
        }
   ],
    "meta": {
        "pagination": {
            "total": "...",
            "count": "...",
            "per_page": "...",
            "current_page": "...",
            "total_pages": "...",
            "links": {
                "previous": "...",
                "next": "..."
            }
        }
    }
 }

Create organisation annotation

Endpoint

POST https://art.ayima.com/api/organisations/{organisationId}/annotations

parameters

name	type	description	required
date	Integer	The date of the annotation event.	✅
type	String	The annotation event type. Options are 'GOOGLE_ALGORITHM', 'COMMENT', 'LINK_BUILT' and 'WEBSITE_UPDATE'	✅
title	String	The title for the annotation	✅
description	String	The description for the annotation	✅
visibility	Array	An array indication for which charts the annotation will be visible. Accepts one or more options of 'mi', 'ranking', 'url' and 'distribution' (competitor landscape, ranking position, URL anaylsis and Distribution respectively)	✅

Response

{
   "created": true
 }

Update organisation annotation

Endpoint

PUT https://art.ayima.com/api/organisations/{organisationId}/annotations/{annotationId}

parameters

name	type	description	required
date	Integer	The date of the annotation event.	✅
type	String	The annotation event type. Options are 'GOOGLE_ALGORITHM', 'COMMENT', 'LINK_BUILT' and 'WEBSITE_UPDATE'	✅
title	String	The title for the annotation	✅
description	String	The description for the annotation	✅
visibility	Array	An array indication for which charts the annotation will be visible. Accepts one or more options of 'mi', 'ranking', 'url' and 'distribution' (competitor landscape, ranking position, URL anaylsis and Distribution respectively)	✅

Response

{
   "updated": true
 }

Delete organisation annotation

Endpoint

DELETE https://art.ayima.com/api/organisations/{organisationId}/annotations/{annotationId}

parameters

N/A

Response

{
   "deleted": true
 }

Organisation team annotations

Get organisation team annotations

Endpoint

GET https://art.ayima.com/api/organisations/{organisationId}/teams/{teamId}/annotations

parameters

name	type	description	required
size	Integer	The number of annotations to show on each page	🚫
col	String	The column to use for sorting. Options are: 'title', 'description', 'date', 'type', 'is_priority', show_in_mi', 'show_in_ranking', 'show_in_url' and 'show_in_distribution'	🚫
col_order_dir	Boolean	If true, sorts data ascendingly, otherwise descendingly	🚫
from	Date	The start date range for result data	🚫
to	String	The end date range for result data	🚫
page	Integer	The current results pages being viewed	🚫

Response

{
   "data": [
        {
            "id": "...",
            "ico": "...",
            "type": "...",
            "title": "...",
            "description": "...",
            "description_raw": "...",
            "type_raw": "...",
            "date": "...",
            "is_global": "...",
            "is_priority": "...",
            "show_in_mi": "...",
            "show_in_ranking": "...",
            "show_in_url": "...",
            "show_in_distribution": "...",
            "created_at": "..."
        }
   ],
    "meta": {
        "pagination": {
            "total": "...",
            "count": "...",
            "per_page": "...",
            "current_page": "...",
            "total_pages": "...",
            "links": {
                "previous": "...",
                "next": "..."
            }
        }
    }
 }

Create organisation team annotation

Endpoint

POST https://art.ayima.com/api/organisations/{organisationId}/teams/{teamId}/annotations

parameters

name	type	description	required
date	Integer	The date of the annotation event.	✅
type	String	The annotation event type. Options are 'GOOGLE_ALGORITHM', 'COMMENT', 'LINK_BUILT' and 'WEBSITE_UPDATE'	✅
title	String	The title for the annotation	✅
description	String	The description for the annotation	✅
visibility	Array	An array indication for which charts the annotation will be visible. Accepts one or more options of 'mi', 'ranking', 'url' and 'distribution' (competitor landscape, ranking position, URL anaylsis and Distribution respectively)	✅

Response

{
   "created": true
 }

Update organisation team annotation

Endpoint

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

parameters

name	type	description	required
date	Integer	The date of the annotation event.	✅
type	String	The annotation event type. Options are 'GOOGLE_ALGORITHM', 'COMMENT', 'LINK_BUILT' and 'WEBSITE_UPDATE'	✅
title	String	The title for the annotation	✅
description	String	The description for the annotation	✅
visibility	Array	An array indication for which charts the annotation will be visible. Accepts one or more options of 'mi', 'ranking', 'url' and 'distribution' (competitor landscape, ranking position, URL anaylsis and Distribution respectively)	✅

Response

{
   "updated": true
 }

Delete organisation team annotation

Endpoint

DELETE https://art.ayima.com/api/organisations/{organisationId}/teams/{teamId}/annotations/{annotationId}

parameters

N/A

Response

{
   "deleted": true
 }