Manage team settings

Read and configure general team settings.

Get settings

GET https://api.supermetrics.com/enterprise/v2/team/settings
Response
PropertyTypeDescription
meta > request_idstring API request ID
datateam_settings Team settings object
HTTP 200 OK
{
    "meta": {
        "request_id": "b74B1EdpXQDZ3c1jhfJYaT8H0lZMirDF"
    },
    "data": {
        "@type": "team_settings",
        "api_json_unescaped_slashes": false,
        "api_json_unescaped_unicode": false,
        "query_default_timezone": null,
        "tableau_default_no_headers": true
    }
}
Permissions

team_settings_read


Update settings

PATCH https://api.supermetrics.com/enterprise/v2/team/settings
  • api_json_unescaped_slashes bool
    Optional. Whether to unescape forward slashes for all authenticated JSON responses.
  • api_json_unescaped_unicode bool
    Optional. Whether to unescape unicode characters for all authenticated JSON responses.
  • query_default_timezone string
    Optional. Default timezone to setting to add all queries that are missing one. Value must be a valid database timezone name or an empty string to reset setting value.
  • tableau_default_no_headers bool
    Optional. Whether Tableau output should hide header row by default.
Request
PATCH https://api.supermetrics.com/enterprise/v2/team/settings
Authorization: Bearer <your api key>
Content-Type: application/json

{
    "query_default_timezone": "America/Chicago"
}
Response

HTTP 200 OK
Response from Get settings

Permissions

team_settings_write


Object reference

team_settings
PropertyTypeDescription
api_json_unescaped_slashesbool Whether to unescape forward slashes for all authenticated JSON responses. Defaults to false. You might need to turn this when integrating into some systems, such as BigQuery.
api_json_unescaped_unicodebool Whether to unescape unicode characters for all authenticated JSON responses. Defaults to false. You might need to turn this on when integrating into some systems, such as BigQuery.
query_default_timezonestring Default timezone to add to all queries that are missing one. Value is either a valid database timezone name or null for system timezone. See timezone setting for more.
tableau_default_no_headersbool Whether Tableau output format should hide header row by default or not. Defaults to true for teams enrolled after June 2nd 2022.
Last updated 2022-09-14 UTC.