cegedim.cloudITCareAPI
Privacy

Matomo

List Matomo Instances

get
Authorizations
Query parameters
namesstring[]Optional

Names, example: matomo1

cloudsstringOptional
Responses
application/vnd.cegedim-it.v1+json
objectOptional
get
GET /itcare/analytics/matomo HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

{
  "content": [
    {
      "actionsInProgress": [
        {
          "family": "text",
          "id": 1,
          "internalId": 1,
          "lastUpdatedAt": "2025-04-20T21:28:21.752Z",
          "message": "text",
          "process": "text",
          "resourceName": "text",
          "resourceType": "text",
          "status": "SUCCESS,IN_PROGRESS,ERROR"
        }
      ],
      "availableActions": [
        {
          "available": true,
          "operation": "text",
          "unavailabilityCauses": [
            "text"
          ]
        }
      ],
      "backupPolicyDetails": {
        "backups": [
          {
            "backupLastDate": "2025-04-20T21:28:21.752Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-04-20T21:28:21.752Z",
            "backupSize": 1,
            "durationInHours": 1,
            "frequencies": {},
            "label": "text",
            "name": "text",
            "policyId": "text",
            "replication": true,
            "scope": "text",
            "startTime": "text",
            "timezone": "text",
            "type": "text"
          }
        ]
      },
      "backupStatus": true,
      "category": "text",
      "cloudId": 1,
      "cloudName": "text",
      "comment": "text",
      "creationTime": "text",
      "creationUser": "text",
      "endOfSalesAt": "2025-04-20T21:28:21.752Z",
      "endOfSupportAt": "2025-04-20T21:28:21.752Z",
      "environment": "text",
      "extendedSupportAt": "2025-04-20T21:28:21.752Z",
      "family": "text",
      "id": 1,
      "internalResourceId": 1,
      "internalType": "text",
      "label": "text",
      "metrologyUrl": "text",
      "monitoringAlerting": true,
      "monitoringEnabled": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "name": "text",
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2025-04-20T21:28:21.752Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-04-20T21:28:21.752Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "releasedAt": "2025-04-20T21:28:21.752Z",
      "replicationStatus": true,
      "resourceType": "text",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "sizing": "text",
      "status": "text",
      "supportPhase": "text",
      "technology": "text",
      "type": "text",
      "url": "text",
      "version": "text"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 1,
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "sort": [
      {
        "ascending": true,
        "direction": "text",
        "ignoreCase": true,
        "nullHandling": "text",
        "property": "text"
      }
    ],
    "unpaged": true
  },
  "size": 1,
  "sort": [
    {
      "ascending": true,
      "direction": "text",
      "ignoreCase": true,
      "nullHandling": "text",
      "property": "text"
    }
  ],
  "totalElements": 1,
  "totalPages": 1
}

Create a Matomo instance

post

This method allows to create a matomo instance.

You will have to know at the minimum :

  • where you want to host your instance (region attribute)
  • name of instance (name attribute)
  • sizing of the instance (sizing attribute). The possible values are : XS (Up to 100K ppm), S(Up to 1M ppm), M(Up to 10M ppm), L(Up to 100M ppm), XL(More than 100M ppm)
  • how to connect to the instance (password attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.
  • On which service the matomo instance belongs to (serviceId attribute).
  • Other settings (defaultWebSiteName, defaultWebUri).

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /analytics/matomo
{
	"name": "pmatomo01",
	"region": "EB",
	"sizing":"XS",
	"serviceId":"123",
	"password": "Password!!??",
	"defaultWebSiteName": "ITCare",
	"defaultWebUri": "https://itcare.cegedim.cloud"
	
}
Authorizations
Body
backupEnabledbooleanOptional

Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.

cloudIdinteger · int64Optional
dbBackupPolicyIdstringOptional

BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.

defaultWebSiteNamestringRequired

Default website name to be configured in Matomo, if left empty, a dummy value will be configured

defaultWebUristringRequired

Default website url to be configured in Matomo, if left empty, a dummy value will be configured

monitoringAlertingbooleanOptional

Indicates if alerting should be activated. If absent, set to false.

monitoringEnabledbooleanOptional

Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.

namestringRequired

Name of Matomo Instance

Pattern: [a-z0-9\-]{4,60}$
noBackupProdReasonstringOptional

Indicates why a production resource is not under backup.

noMonitoringProdReasonstringOptional

Indicates why a production resource is not under monitoring.

noReplicationProdReasonstringOptional

Indicates why a production resource is not replicated.

onCallSupervisionbooleanOptional

Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.

passwordstringRequired

Password to connect to the matomo instance.

regionstringRequired

Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

regulationstringOptional

Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.

replicationEnabledbooleanOptional

Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment

serverBackupPolicyIdstringOptional

BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.

serviceIdinteger · int64Required

id of service to put instance in.

sizingstringRequired

Sizing. L, XL , XS, S, M. Sizing for matomo instances

Responses
application/vnd.cegedim-it.v1+json
objectOptional

An action gives status about processing of a task previously launched by an API call and asynchronously processed.

post
POST /itcare/analytics/matomo HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 434

{
  "backupEnabled": true,
  "cloudId": 1,
  "dbBackupPolicyId": "text",
  "defaultWebSiteName": "text",
  "defaultWebUri": "text",
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "name": "text",
  "noBackupProdReason": "text",
  "noMonitoringProdReason": "text",
  "noReplicationProdReason": "text",
  "onCallSupervision": true,
  "password": "text",
  "region": "text",
  "regulation": "text",
  "replicationEnabled": true,
  "serverBackupPolicyId": "text",
  "serviceId": 1,
  "sizing": "text"
}
{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-04-20T21:28:21.752Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Delete a Matomo instance

delete

This method allows to delete a matomo instance.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /analytics/matomo/123
Authorizations
Path parameters
idinteger · int64Required

id, example: 123

Responses
application/vnd.cegedim-it.v1+json
objectOptional

An action gives status about processing of a task previously launched by an API call and asynchronously processed.

delete
DELETE /itcare/analytics/matomo/{id} HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-04-20T21:28:21.752Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Get a Matomo Instance

get
Authorizations
Path parameters
idinteger · int64Required

id, example: 123

Responses
application/vnd.cegedim-it.v1+json
objectOptional
get
GET /itcare/analytics/matomo/{id} HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

{
  "actionsInProgress": [
    {
      "family": "text",
      "id": 1,
      "internalId": 1,
      "lastUpdatedAt": "2025-04-20T21:28:21.752Z",
      "message": "text",
      "process": "text",
      "resourceName": "text",
      "resourceType": "text",
      "status": "SUCCESS,IN_PROGRESS,ERROR"
    }
  ],
  "availableActions": [
    {
      "available": true,
      "operation": "text",
      "unavailabilityCauses": [
        "text"
      ]
    }
  ],
  "backupPolicyDetails": {
    "backups": [
      {
        "backupLastDate": "2025-04-20T21:28:21.752Z",
        "backupSize": 1,
        "id": 1,
        "type": "text"
      }
    ],
    "policies": [
      {
        "backupLastDate": "2025-04-20T21:28:21.752Z",
        "backupSize": 1,
        "durationInHours": 1,
        "frequencies": {},
        "label": "text",
        "name": "text",
        "policyId": "text",
        "replication": true,
        "scope": "text",
        "startTime": "text",
        "timezone": "text",
        "type": "text"
      }
    ]
  },
  "backupStatus": true,
  "category": "text",
  "cloudId": 1,
  "cloudName": "text",
  "comment": "text",
  "creationTime": "text",
  "creationUser": "text",
  "endOfSalesAt": "2025-04-20T21:28:21.752Z",
  "endOfSupportAt": "2025-04-20T21:28:21.752Z",
  "environment": "text",
  "extendedSupportAt": "2025-04-20T21:28:21.752Z",
  "family": "text",
  "id": 1,
  "internalResourceId": 1,
  "internalType": "text",
  "label": "text",
  "metrologyUrl": "text",
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "monitoringOnCallEnabled": true,
  "monitoringRequested": true,
  "name": "text",
  "patchParty": {
    "excluded": true,
    "excludedBy": "text",
    "exclusionDate": "2025-04-20T21:28:21.752Z",
    "exclusionReason": "text",
    "id": 1,
    "name": "text",
    "patchDate": "2025-04-20T21:28:21.752Z",
    "patchGroup": "text",
    "patchTag": "text"
  },
  "path": "text",
  "prettyLabel": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "releasedAt": "2025-04-20T21:28:21.752Z",
  "replicationStatus": true,
  "resourceType": "text",
  "serviceId": 1,
  "serviceKey": "text",
  "serviceName": "text",
  "sizing": "text",
  "status": "text",
  "supportPhase": "text",
  "technology": "text",
  "type": "text",
  "url": "text",
  "version": "text"
}

Update a Matomo instance

patch

This method allows to update a matomo instance.

Structure of payload is generic and describes :

  • operation you want to be performed
  • options data relative to the operation performed - see details - optional.

Below are different operations currently implemented.

Start matomo instance

Use the start operation to start a matomo instance.

Starts matomo instance.

This method is synchronous (status code 202).

Example :

PATCH /analytics/matomo/1234
{
    "operation": "start"
}

Stop matomo instance

Use the stop operation to stop the nodes of the matomo instance and the instance itself.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /analytics/matomo/1234
{
	"operation":"stop"
}

Extend matomo instance

Use the extend operation to stop the nodes of the matomo instance and the instance itself.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /analytics/matomo/1234
{
	"operation":"extend",
	"options" : {
	  "sizing" : "M"
	}
}
Authorizations
Path parameters
idinteger · int64Required

id, example: 123

Body
operationstringOptional
optionsobjectOptional
Responses
application/vnd.cegedim-it.v1+json
objectOptional

An action gives status about processing of a task previously launched by an API call and asynchronously processed.

patch
PATCH /itcare/analytics/matomo/{id} HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "operation": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-04-20T21:28:21.752Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}
PreviousAnalyticsNextChanges

Last updated