Skip to main content

​
/Tableau/createDashboard

Creates a Dashboard record Common Parameters:
  • title required The title of your Dashboard
  • url required This is the url of the Dashboard on the Tableau Server environment.
  • slug This is the url of the Dashboard on the Curator environment.
  • preloaded_filters_params An array of objects defining filters or parameters to apply when the Dashboard loads. Each object accepts the following fields:
    • name required The name of the filter or parameter. Must match the name in the data source.
    • value The value to apply on Dashboard load. Multiple values can be separated with ||| (three pipes, no spaces). Null and empty string values are allowed.
    • type required Must be filter or parameter.
    • load_domain_values required Must be 0 (Off) or 1 (On). When enabled for filters, all possible filter values remain available in Curator Filters even after preloading specific values.
Note: Other optional parameters, such as keywords, featured, etc. are supported but not listed here. Returns: array Example Response: 
    {
        "result": "Success",
        "msg": "Created dashboard record",
        "dashboard": {...},
    }

​
/Tableau/updateDashboard

Updates an existing Dashboard record. Common Parameters:
  • id required The ID of the Dashboard to update.
  • slug The url of the Dashboard on the Curator environment.
  • preloaded_filters_params An array of objects defining filters or parameters to apply when the Dashboard loads. Each object accepts the following fields:
    • name required The name of the filter or parameter. Must match the name in the data source.
    • value The value to apply on Dashboard load. Multiple values can be separated with ||| (three pipes, no spaces). Null and empty string values are allowed.
    • type required Must be filter or parameter.
    • load_domain_values required Must be 0 (Off) or 1 (On). When enabled for filters, all possible filter values remain available in Curator Filters even after preloading specific values.
Note: Other optional parameters, such as title, url, featured, etc. are supported but not listed here. Returns: array Example Request Body: 
    {
        "id": 1,
        "slug": "my-dashboard",
        "preloaded_filters_params": [
            {
                "name": "Region",
                "value": "West|||East",
                "type": "filter",
                "load_domain_values": 1
            },
            {
                "name": "Year",
                "value": "2023",
                "type": "parameter",
                "load_domain_values": 0
            }
        ]
    }
Example Response: 
    {
        "result": "Success",
        "msg": "Updated dashboard record",
        "dashboard": {...}
    }

​
/Tableau/syncTags

Kicks off tag schedule which synchronizes tags from Tableau Server Returns: string Example Response: 
    {
        "result": "Success",
        "msg": "Tag sync is complete"
    }

​
/Tableau/syncGroups

Kicks off a schedule which synchronizes groups from Tableau Server. Returns: array Example Response: 
    {
        "result": "Success",
        "msg": "Group sync is complete"
    }

​
/Tableau/listUsers

Lists users and groups. Returns: array Example Response: 
    [
        {
            "tableau_user_id": "21342134-236a-49f9-88e9-224272ab312c",
            "name": "CuratorDemo",
            "full_name": "Curator Demo",
            "site_role": "SiteAdministrator",
            "skip_sync": null,
            "groups": []
        },
        {
            "tableau_user_id": "12341234-89a3-4fde-acd9-a3b806995d69",
            "name": "admin",
            "full_name": "Administrator",
            "site_role": "ServerAdministrator",
            "skip_sync": null,
            "groups": []
        }
    ]

​
/Tableau/setAuthentication

Sets the authentication type. Returns: array

​
Tableau/setRest

Sets the REST credentials for Tableau Server Settings. Returns: array

​
/Tableau/syncTableauDashboardIds

Kicks off tag schedule which synchronizes tags from Tableau Server Returns: string Example Response: 
    {
        "result": "Success",
        "msg": 0
    }

​
/Tableau/resetViews

Kicks off a schedule task which clears out the Dashboard views Returns: string Example Response: 
    {
        "result": "Success",
        "msg": 0
    }

​
/Tableau/refreshGroups

Kicks off tag schedule which clears the old groups and adds in new groups Returns: string Example Response: 
    {
        "result": "Success",
        "msg": 0
    }

​
/Tableau/refreshThumbnails

Kicks off task which refreshes all thumbnails. Returns: string Example Response: 
    {
        "result": "Success",
        "msg": "Dashboard thumbnails are refreshed."
    }