boards

Create Stats Block

post/v3.0/boards/{boardSlug}/blocks/stats/

Request

  • Base URL: https://api.formaloo.me
  • URL: https://api.formaloo.me/v3.0/boards/{boardSlug}/blocks/stats/
  • Auth: none declared. Required headers: x-api-key

Path parameters

boardSlugstring required

Headers

x-api-keystring required

The application secret provided to the client.

x-workspacestring

The value of business_identifier for the current workspace. Not required if your're using the API Key generated for your workspace.

Request body

formstring
positioninteger
titlestring nullable
location'left-sidebar' | 'right-sidebar' | 'header' | 'footer' | 'main' | 'non-primary'
colorstring nullable

color of block

configobject nullable
workspace_access'owner' | 'admin' | 'team_member' | 'guest'
access_settingsobject nullable
stats_settingsobject

shows list of available stats and whether they're active on the board.

rolesinteger[]

roles that have access to this block.

Response

type'generic' | 'menu' | 'stats' | 'form_display' | 'form_result' | 'form_charts' | 'report' | 'kanban' | 'content' | 'ai_summary'
slugstring nullable
formstring
statsobject
created_atstring date-time
updated_atstring date-time
positioninteger
titlestring nullable
location'left-sidebar' | 'right-sidebar' | 'header' | 'footer' | 'main' | 'non-primary'
colorstring nullable

color of block

configobject nullable
workspace_access'owner' | 'admin' | 'team_member' | 'guest'
access_settingsobject nullable
stats_settingsobject

shows list of available stats and whether they're active on the board.

rolesinteger[]

roles that have access to this block.

Changes

No recorded changes to this operation across all 1 revision of this API.