Summarize websites

GET

https://api.modulards.com/api/public/v1/sites/summary

GET

/api/public/v1/sites/summary

curl https://api.modulards.com/api/public/v1/sites/summary \
     -H "Authorization: Bearer <token>"

200200 OK

{
  "jsonapi": {
    "version": "1.1"
  },
  "meta": {
    "connector_version": [
      {
        "sites_count": 39,
        "value": "1.4.0"
      },
      {
        "sites_count": 3,
        "value": null
      }
    ],
    "core_version": [
      {
        "sites_count": 30,
        "value": "6.8.1"
      },
      {
        "sites_count": 9,
        "value": "6.7.2"
      },
      {
        "sites_count": 3,
        "value": null
      }
    ],
    "db_engine_version": [
      {
        "db_engine": "mysql",
        "sites_count": 22,
        "value": "8.0.0"
      },
      {
        "db_engine": "mariadb",
        "sites_count": 17,
        "value": "10.11.2"
      },
      {
        "db_engine": null,
        "sites_count": 3,
        "value": null
      }
    ],
    "engine_version": [
      {
        "sites_count": 25,
        "value": "8.2.27"
      },
      {
        "sites_count": 14,
        "value": "8.1.0"
      },
      {
        "sites_count": 3,
        "value": null
      }
    ],
    "total": 42
  }
}

Returns how many websites you have and how they are spread across the versions they run: WordPress, PHP, the Modular Connector plugin and the database. Use it to answer questions such as “how many of my websites still run an old PHP version?” without listing every website.

The counts cover the websites your token can reach. Narrow them with the same filters as “List websites”, for example one team or one tag. Only filter is accepted: there is nothing to sort, page or include here, so sort, page, fields and include answer 422.

Each list has one row per version, newest first, plus a row without a version for websites that have never synchronized, and adds up to the total.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Query parameters

filter[id][]stringOptional

Website ids. Several values match any of them.

filter[team][]stringOptional

Team ids. Several values match websites in any of these teams.

filter[tags][]stringOptional

Tag ids. Several values match websites carrying any of these tags.

filter[connected]stringOptional

1 for websites whose connection works, 0 for websites that are not connected.

filter[s]stringOptional

Free-text search on the website's name, slug or address.

filter[core_version][]stringOptional

Exact WordPress versions, for example 6.8.1. Several values match any of them.

filter[engine_version][]stringOptional

Exact PHP versions, for example 8.2.27. Several values match any of them.

filter[alerts][]stringOptional

Notification configuration ids. Several values match websites associated with any of them.

filter[patchstack]stringOptional

1 for websites with Patch & Protect switched on, 0 for websites without it.

Response

200 OK

jsonapiobjectOptional

metaobjectOptional