Organisation websites

Get all

Endpoint

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

parameters

N/A

Response

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

Get singular

Endpoint

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

Parameters

N/A

Response

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

Create

Endpoint

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

parameters

name	type	description	required
name	String	The name for the website you would like to create.	✅
website	String	The full website address.	✅
is_competitor	Boolean	Indication if the website should be associated as a competitor.	✅

Response

{
    "created": true
}

Update

Endpoint

PUT https://art.ayima.com/api/organisations//{organisationId}/website/{websiteId}

parameters

name	type	description	required
name	String	The name for the website you would like to create.	✅
website	String	The full website address.	✅
is_competitor	Boolean	Indication if the website should be associated as a competitor.	✅

Response

{
    "updated": true
}

Delete

Endpoint

DELETE https://art.ayima.com/api/organisations//{organisationId}/website/{websiteId}

parameters

N/A

Response

{
    "deleted": true
}