list_installations
Lists a product’s installations (one per site), newest first: domain, status, lost, edition, plugin / WordPress / PHP version, country, locale, last seen and installed dates. Filter by status (active, deactivated, removed, lost), versions, country, locale, edition, part of a domain, or install date. Site admins are only in get_installation. Paginated: pass next_cursor back as cursor. Costs 3 rate-limit units.
- Server: Organization server
- Scope:
analytics:read - Read-only: yes
Input
{
"properties": {
"product": {
"description": "The product id (UUID) or slug, as list_products returns them.",
"type": "string"
},
"status": {
"enum": [
"active",
"deactivated",
"removed",
"lost"
],
"type": "string"
},
"plugin_version": {
"type": "string"
},
"wordpress_version": {
"type": "string"
},
"php_version": {
"type": "string"
},
"country": {
"description": "Two-letter country code.",
"type": "string"
},
"locale": {
"description": "e.g. en_US",
"type": "string"
},
"edition": {
"enum": [
"free",
"premium",
"unknown"
],
"type": "string"
},
"search": {
"description": "Part of the site domain.",
"type": "string"
},
"installed_from": {
"description": "YYYY-MM-DD, in the organization timezone.",
"type": "string"
},
"installed_to": {
"description": "YYYY-MM-DD, inclusive.",
"type": "string"
},
"cursor": {
"type": "string"
},
"limit": {
"minimum": 1,
"maximum": 100,
"type": "integer"
}
},
"type": "object",
"required": [
"product"
]
}Output (structuredContent)
{
"properties": {
"as_of": {
"type": "string"
},
"product_id": {
"type": "string"
},
"installations": {
"items": {
"properties": {
"id": {
"type": "string"
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"lost": {
"type": "boolean"
},
"edition": {
"type": [
"string",
"null"
]
},
"plugin_version": {
"type": [
"string",
"null"
]
},
"wordpress_version": {
"type": [
"string",
"null"
]
},
"php_version": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"locale": {
"type": [
"string",
"null"
]
},
"last_seen_at": {
"type": [
"string",
"null"
]
},
"installed_at": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": "array"
},
"next_cursor": {
"type": [
"string",
"null"
]
}
},
"type": "object",
"required": [
"as_of",
"product_id",
"installations",
"next_cursor"
]
}