Summarize site items

GET

https://api.modulards.com/api/public/v1/site-items/summary

Returns totals of the items installed on your websites, per type (plugins, themes and WordPress versions) and for the websites themselves. Use it for an overview, for example how many plugins can be updated and how many have a known vulnerability, without listing every item.

The totals cover connected websites only and accept the same filters as “List site items”, so items whose update notice is hidden are left out unless you send filter[is_hidden]. An item counts as updatable only when a newer version exists, its update notice is not hidden and its website accepts installs. Only filter is accepted: sort, page, fields and include answer 422. The answer can be a few seconds behind the latest change.

Authentication

AuthorizationBearer

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

Query parameters

filter[site][]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[core_version][]stringOptional

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

filter[engine_version][]stringOptional

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

filter[type][]stringOptional

Item types: core, plugin or theme. Several values match any of them.

filter[component]stringOptional

Component id: counts only the installs of one plugin, theme or WordPress version.

filter[status][]stringOptional

Item states: active, inactive or uninstalled. Several values match any of them.

filter[update_available]stringOptional

1 for items with a newer version available, 0 for items that are up to date.

filter[updatable]stringOptional

1 for items that can be updated now: a newer version exists, the update notice is not hidden and the website accepts installs. 0 for the rest.

filter[has_vulnerabilities]stringOptional

1 for items whose installed version has a known vulnerability, 0 for items without one.

filter[is_hidden]stringOptional

1 for items whose update notice is hidden, 0 for visible ones. Default: only visible items.

filter[s]stringOptional

Free-text search on the item's name.

Response

200 - Site items summary

jsonapiobjectOptional

metaobjectOptional