Create Analytics Theme

Make a theme your organization can put on any page or folder. Leave an option out to keep the default look for it.

POST

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments

stringrequired

The theme name.

The theme name, 1 to 255 characters.

object

The look, option by option, such as fontFamily, panelCorners or seriesColors.

The look, option by option. An option left out or null uses the default.

fontFamilystring
Font family. One of: "Inter, sans-serif" (Inter), ""SF Pro Display", -apple-system, sans-serif" (SF Pro Display), ""Helvetica Neue", Helvetica, sans-serif" (Helvetica Neue), "system-ui, sans-serif" (System UI), ""Segoe UI", sans-serif" (Segoe UI), "Roboto, sans-serif" (Roboto), ""Open Sans", sans-serif" (Open Sans), "Lato, sans-serif" (Lato), ""Source Sans 3", sans-serif" (Source Sans), ""IBM Plex Sans", sans-serif" (IBM Plex Sans), ""Atkinson Hyperlegible", sans-serif" (Atkinson Hyperlegible), "Georgia, "Times New Roman", serif" (Georgia), ""IBM Plex Mono", monospace" (IBM Plex Mono). null or left out uses the default.
- Inter, sans-serif
- "SF Pro Display", -apple-system, sans-serif
- "Helvetica Neue", Helvetica, sans-serif
- system-ui, sans-serif
- "Segoe UI", sans-serif
- Roboto, sans-serif
- "Open Sans", sans-serif
- Lato, sans-serif
- "Source Sans 3", sans-serif
- "IBM Plex Sans", sans-serif
- "Atkinson Hyperlegible", sans-serif
- Georgia, "Times New Roman", serif
- "IBM Plex Mono", monospace
fontScalestring
Font size. One of: "0.9" (Small), "1" (Medium), "1.1" (Large), "1.25" (Extra Large). null or left out uses the default.
- 1
- 0.9
- 1.1
- 1.25
panelTitleWeightstring
Panel title weight. One of: "regular" (Regular), "medium" (Medium), "bold" (Bold). null or left out uses the default.
- regular
- medium
- bold
pageTitleSizestring
Page title size. One of: "compact" (Compact), "regular" (Regular), "large" (Large). null or left out uses the default.
- compact
- regular
- large
seriesColorsarray of objects
Series colors: up to 8 light and dark color pairs, in the order charts hand colors out (the first is the first series).
statusColorsobject
Status colors: a light and dark color pair for success (Success), warning (Warning), warningBright (Caution), failure (Failure).
- successobject
  Success: a light and dark color pair, or null for the default.
  - lightstringrequired
    The color in light mode, as hex like #2563eb.
  - darkstringrequired
    The color in dark mode, as hex like #2563eb.
- warningobject
  Warning: a light and dark color pair, or null for the default.
  - lightstringrequired
    The color in light mode, as hex like #2563eb.
  - darkstringrequired
    The color in dark mode, as hex like #2563eb.
- warningBrightobject
  Caution: a light and dark color pair, or null for the default.
  - lightstringrequired
    The color in light mode, as hex like #2563eb.
  - darkstringrequired
    The color in dark mode, as hex like #2563eb.
- failureobject
  Failure: a light and dark color pair, or null for the default.
  - lightstringrequired
    The color in light mode, as hex like #2563eb.
  - darkstringrequired
    The color in dark mode, as hex like #2563eb.
chartGridlinesstring
Chart gridlines. One of: "off" (Off), "dashed" (Dashed), "solid" (Solid). null or left out uses the default.
- off
- dashed
- solid
chartAreaFillstring
Area fill. One of: "none" (None), "light" (Light), "solid" (Solid). null or left out uses the default.
- none
- light
- solid
chartCurvestring
Line curve. One of: "straight" (Straight), "smooth" (Smooth), "natural" (Curved). null or left out uses the default.
- straight
- smooth
- natural
chartPointsstring
Point marks. One of: "shown" (Shown), "hidden" (Hidden). null or left out uses the default.
- shown
- hidden
chartValuesstring
Value labels. One of: "shown" (Shown), "hidden" (Hidden). null or left out uses the default.
- shown
- hidden
chartLegendstring
Legend. One of: "auto" (Auto), "shown" (Shown), "hidden" (Hidden). null or left out uses the default.
- auto
- shown
- hidden
numberFormatstring
Number format. One of: "point" (1,234.56), "comma" (1.234,56), "space" (1 234,56). null or left out uses the default.
- point
- comma
- space
numberCompactstring
Compact numbers. One of: "auto" (Auto), "always" (Always), "never" (Never). null or left out uses the default.
- auto
- always
- never
dateOrderstring
Date order. One of: "monthFirst" (Jan 6, 2026), "dayFirst" (6 Jan 2026). null or left out uses the default.
- monthFirst
- dayFirst
dateStylestring
Date style. One of: "short" (Short), "medium" (Medium), "numeric" (Numeric). null or left out uses the default.
- short
- medium
- numeric
panelCornersstring
Panel corners. One of: "square" (Square), "rounded" (Rounded), "soft" (Soft). null or left out uses the default.
- square
- rounded
- soft
panelElevationstring
Panel elevation. One of: "none" (None), "hairline" (Hairline), "raised" (Raised). null or left out uses the default.
- none
- hairline
- raised
panelGapstring
Panel gap. One of: "none" (None), "tight" (Tight), "regular" (Regular), "wide" (Wide). null or left out uses the default.
- none
- tight
- regular
- wide
panelPaddingstring
Panel padding. One of: "compact" (Compact), "regular" (Regular), "comfortable" (Comfortable). null or left out uses the default.
- compact
- regular
- comfortable
tableDensitystring
Table density. One of: "compact" (Compact), "regular" (Regular), "comfortable" (Comfortable). null or left out uses the default.
- compact
- regular
- comfortable
pageBackgroundobject
Page background: a light and dark color pair for page (Page).
- pageobject
  Page: a light and dark color pair, or null for the default.
  - lightstringrequired
    The color in light mode, as hex like #2563eb.
  - darkstringrequired
    The color in dark mode, as hex like #2563eb.
panelFillobject
Panel fill: a light and dark color pair for panel (Panel).
- panelobject
  Panel: a light and dark color pair, or null for the default.
  - lightstringrequired
    The color in light mode, as hex like #2563eb.
  - darkstringrequired
    The color in dark mode, as hex like #2563eb.
inkobject
Ink: a light and dark color pair for ink (Ink).
- inkobject
  Ink: a light and dark color pair, or null for the default.
  - lightstringrequired
    The color in light mode, as hex like #2563eb.
  - darkstringrequired
    The color in dark mode, as hex like #2563eb.
lineColorobject
Line color: a light and dark color pair for line (Line).
- lineobject
  Line: a light and dark color pair, or null for the default.
  - lightstringrequired
    The color in light mode, as hex like #2563eb.
  - darkstringrequired
    The color in dark mode, as hex like #2563eb.
brandHeaderColorobject
Publication header color: a light and dark color pair for header (Header).
- headerobject
  Header: a light and dark color pair, or null for the default.
  - lightstringrequired
    The color in light mode, as hex like #2563eb.
  - darkstringrequired
    The color in dark mode, as hex like #2563eb.
cirraMarkstring
Cirra mark. One of: "shown" (Shown), "hidden" (Hidden). null or left out uses the default.
- shown
- hidden

boolean

true makes new pages start with this theme.

true makes new pages in the organization start with this theme.

Response fields

idstring

Unique id of the theme.

namestring

The theme name.

isDefaultboolean

Whether new pages in the organization start with this theme. When no theme is the default, new pages wear the plain Cirra look.

styleobject

The look the theme gives a page, option by option. An option it leaves out keeps the default.

fontFamilystring
Font family. One of: "Inter, sans-serif" (Inter), ""SF Pro Display", -apple-system, sans-serif" (SF Pro Display), ""Helvetica Neue", Helvetica, sans-serif" (Helvetica Neue), "system-ui, sans-serif" (System UI), ""Segoe UI", sans-serif" (Segoe UI), "Roboto, sans-serif" (Roboto), ""Open Sans", sans-serif" (Open Sans), "Lato, sans-serif" (Lato), ""Source Sans 3", sans-serif" (Source Sans), ""IBM Plex Sans", sans-serif" (IBM Plex Sans), ""Atkinson Hyperlegible", sans-serif" (Atkinson Hyperlegible), "Georgia, "Times New Roman", serif" (Georgia), ""IBM Plex Mono", monospace" (IBM Plex Mono). Absent when the default is used.
- Inter, sans-serif
- "SF Pro Display", -apple-system, sans-serif
- "Helvetica Neue", Helvetica, sans-serif
- system-ui, sans-serif
- "Segoe UI", sans-serif
- Roboto, sans-serif
- "Open Sans", sans-serif
- Lato, sans-serif
- "Source Sans 3", sans-serif
- "IBM Plex Sans", sans-serif
- "Atkinson Hyperlegible", sans-serif
- Georgia, "Times New Roman", serif
- "IBM Plex Mono", monospace
fontScalestring
Font size. One of: "0.9" (Small), "1" (Medium), "1.1" (Large), "1.25" (Extra Large). Absent when the default is used.
- 0.9
- 1
- 1.1
- 1.25
panelTitleWeightstring
Panel title weight. One of: "regular" (Regular), "medium" (Medium), "bold" (Bold). Absent when the default is used.
- regular
- medium
- bold
pageTitleSizestring
Page title size. One of: "compact" (Compact), "regular" (Regular), "large" (Large). Absent when the default is used.
- compact
- regular
- large
seriesColorsarray
Series colors: light and dark color pairs in the order charts hand colors out; a null entry uses that slot's default. Absent when the defaults are used.
- lightstring
  The color in light mode, as hex.
- darkstring
  The color in dark mode, as hex.
statusColorsobject
Status colors, a light and dark color pair per entry. Absent when the defaults are used.
- successobject
  Success, or null for the default.
  - lightstring
    The color in light mode, as hex.
  - darkstring
    The color in dark mode, as hex.
- warningobject
  Warning, or null for the default.
  - lightstring
    The color in light mode, as hex.
  - darkstring
    The color in dark mode, as hex.
- warningBrightobject
  Caution, or null for the default.
  - lightstring
    The color in light mode, as hex.
  - darkstring
    The color in dark mode, as hex.
- failureobject
  Failure, or null for the default.
  - lightstring
    The color in light mode, as hex.
  - darkstring
    The color in dark mode, as hex.
chartGridlinesstring
Chart gridlines. One of: "off" (Off), "dashed" (Dashed), "solid" (Solid). Absent when the default is used.
- off
- dashed
- solid
chartAreaFillstring
Area fill. One of: "none" (None), "light" (Light), "solid" (Solid). Absent when the default is used.
- none
- light
- solid
chartCurvestring
Line curve. One of: "straight" (Straight), "smooth" (Smooth), "natural" (Curved). Absent when the default is used.
- straight
- smooth
- natural
chartPointsstring
Point marks. One of: "shown" (Shown), "hidden" (Hidden). Absent when the default is used.
- shown
- hidden
chartValuesstring
Value labels. One of: "shown" (Shown), "hidden" (Hidden). Absent when the default is used.
- shown
- hidden
chartLegendstring
Legend. One of: "auto" (Auto), "shown" (Shown), "hidden" (Hidden). Absent when the default is used.
- auto
- shown
- hidden
numberFormatstring
Number format. One of: "point" (1,234.56), "comma" (1.234,56), "space" (1 234,56). Absent when the default is used.
- point
- comma
- space
numberCompactstring
Compact numbers. One of: "auto" (Auto), "always" (Always), "never" (Never). Absent when the default is used.
- auto
- always
- never
dateOrderstring
Date order. One of: "monthFirst" (Jan 6, 2026), "dayFirst" (6 Jan 2026). Absent when the default is used.
- monthFirst
- dayFirst
dateStylestring
Date style. One of: "short" (Short), "medium" (Medium), "numeric" (Numeric). Absent when the default is used.
- short
- medium
- numeric
panelCornersstring
Panel corners. One of: "square" (Square), "rounded" (Rounded), "soft" (Soft). Absent when the default is used.
- square
- rounded
- soft
panelElevationstring
Panel elevation. One of: "none" (None), "hairline" (Hairline), "raised" (Raised). Absent when the default is used.
- none
- hairline
- raised
panelGapstring
Panel gap. One of: "none" (None), "tight" (Tight), "regular" (Regular), "wide" (Wide). Absent when the default is used.
- none
- tight
- regular
- wide
panelPaddingstring
Panel padding. One of: "compact" (Compact), "regular" (Regular), "comfortable" (Comfortable). Absent when the default is used.
- compact
- regular
- comfortable
tableDensitystring
Table density. One of: "compact" (Compact), "regular" (Regular), "comfortable" (Comfortable). Absent when the default is used.
- compact
- regular
- comfortable
pageBackgroundobject
Page background, a light and dark color pair per entry. Absent when the defaults are used.
- pageobject
  Page, or null for the default.
  - lightstring
    The color in light mode, as hex.
  - darkstring
    The color in dark mode, as hex.
panelFillobject
Panel fill, a light and dark color pair per entry. Absent when the defaults are used.
- panelobject
  Panel, or null for the default.
  - lightstring
    The color in light mode, as hex.
  - darkstring
    The color in dark mode, as hex.
inkobject
Ink, a light and dark color pair per entry. Absent when the defaults are used.
- inkobject
  Ink, or null for the default.
  - lightstring
    The color in light mode, as hex.
  - darkstring
    The color in dark mode, as hex.
lineColorobject
Line color, a light and dark color pair per entry. Absent when the defaults are used.
- lineobject
  Line, or null for the default.
  - lightstring
    The color in light mode, as hex.
  - darkstring
    The color in dark mode, as hex.
brandHeaderColorobject
Publication header color, a light and dark color pair per entry. Absent when the defaults are used.
- headerobject
  Header, or null for the default.
  - lightstring
    The color in light mode, as hex.
  - darkstring
    The color in dark mode, as hex.
cirraMarkstring
Cirra mark. One of: "shown" (Shown), "hidden" (Hidden). Absent when the default is used.
- shown
- hidden

createdOndate

When the theme was created.

updatedOndate

When the theme was last changed.