/dashboards/get

GET https://tezzela.com/api/v1/dasboards/get

Description

This endpoint retrieves a specific dashboard using its unique id and the to (recipient) email address. It returns the full dashboard definition, including title, widgets, and current values.

This is useful when you need to:

• Retrieve an existing dashboard to update its content dynamically.

• Verify the current state of a dashboard before publishing a new version.

• Get a ready-to-edit structure for creating a new dashboard if one doesn't exist yet.

Behavior When Dashboard Does Not Exist

If no dashboard is found for the given id and to, the endpoint will still return a valid dashboard structure. This structure:

• Includes the provided id and to values.

• Has a default title of "new" unless a title is explicitly included in the request payload, in which case that title will be used.

• Contains an empty widgets list.

This design allows clients to immediately use the returned structure as a draft, ready to be populated and saved using the /dashboards/static endpoint.

Request Body

{
    "id": "purchases-dashboard",
    "title": "Purchases", // Optional – used if dashboard does not exist     
    "to": "[email protected]"
}

Response

If Dashboard Exists:

{
    "data": {
        "title": "Purchases",
        "id": "purchases-dashboard",
        "to": "[email protected]",
        "widgets": [
            {
                "id": "purchases-widget",
                "type": "text",
                "title": "Compras",
                "value": "22.168,44 €",
                "sub": "este mes"
            }
        ]
    }
}

If Dashboard Does Not Exist:

{
    "data": {
        "title": "new", // or the title sent in the request
        "id": "purchases-dashboard",
        "to": "[email protected]",
        "widgets": []
    }
}