The whole home screen in one call
Composes every block of the home screen in a single round trip: operational health, publications, publication metrics, account metrics, plan use, AI plans, the best AI plans and unread messages.
A block the caller cannot read is omitted, not refused. The endpoint only demands the minimum permission — reading the organization — and then checks each block on its own: somebody who can only see publications still gets their home instead of a 403. available_blocks says which blocks were allowed, so an absent block for lack of permission and an absent block for lack of data can be drawn differently.
The messages block is also omitted when the client's plan has no messaging.
Request
- Base URL: https://api.planvortex.com/v1.0.0
- URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/dashboard
- Auth: one of:
- HTTP bearer
- OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)
Path parameters
Organization identifier
Query parameters
Start of the range, ISO 8601. Defaults to 30 days before to_date. A range longer than 366 days answers error 1003.
End of the range, ISO 8601. Defaults to now.
Response
The dashboard
Example response
{
"publication_metrics": {
"top": [
{
"publication": {
"files": [
{
"file_properties": {
"aspect_ratio": {
"value": 1.7777777777777777,
"text": "16:9"
}
},
"public_path": "https://a1b2c3d4e5f6.eu.r2.cloudflarestorage.com/planvortex-prod/orgs/60b.../60c.../foto.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=86400&X-Amz-Signature=..."
}
]
}
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.