Skip to main content

list-custom-themes 

dci list-custom-themes

Returns the list of custom color themes defined for your account.

Responses​

200 (application/json)​

OK - The request succeeded.

{
  "type": "object",
  "properties": {
    "rowCount": {
      "type": "integer",
      "description": "Total number of custom themes in the result set."
    },
    "themes": {
      "type": "array",
      "items": {
        "required": [
          "id",
          "name",
          "primaryColor",
          "colors"
        ],
        "type": "object",
        "description": "A custom color theme applied to Cloud Analytics reports.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the custom theme."
          },
          "name": {
            "type": "string",
            "description": "The display name of the custom theme.",
            "maxLength": 200
          },
          "primaryColor": {
            "type": "string",
            "description": "A color in hex notation. Accepts `#RGB`, `#RRGGBB`, or `#RRGGBBAA`.",
            "pattern": "^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
            "example": "#1A73E8"
          },
          "colors": {
            "type": "object",
            "required": [
              "light",
              "dark"
            ],
            "description": "Palettes for light and dark display modes. Each palette must contain between 1 and 32 hex colors.",
            "properties": {
              "light": {
                "type": "array",
                "minItems": 1,
                "maxItems": 32,
                "items": {
                  "type": "string",
                  "description": "A color in hex notation. Accepts `#RGB`, `#RRGGBB`, or `#RRGGBBAA`.",
                  "pattern": "^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
                  "example": "#1A73E8"
                },
                "description": "Colors used when the report is displayed in light mode."
              },
              "dark": {
                "type": "array",
                "minItems": 1,
                "maxItems": 32,
                "items": {
                  "type": "string",
                  "description": "A color in hex notation. Accepts `#RGB`, `#RRGGBB`, or `#RRGGBBAA`.",
                  "pattern": "^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
                  "example": "#1A73E8"
                },
                "description": "Colors used when the report is displayed in dark mode."
              }
            }
          },
          "createTime": {
            "type": "string",
            "format": "date-time",
            "description": "The creation time of the custom theme."
          },
          "updateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The time when the custom theme was last updated."
          }
        }
      }
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)​

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: list-custom-themes, listcustomthemes