Skip to main content
POST
Create a report

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Body

application/json
name
string
required

Unique across the workspace

Required string length: 1 - 255
description
string | null
Maximum string length: 2000
owner
string | null

The email of a current member of your workspace: they can change it in the app. Left out, a team report has no owner and only admins can change it in the app. A private report needs one

Required string length: 3 - 320
Pattern: ^[^@\s]+@[^@\s]+$
visibility
enum<string>
default:team

team (everyone in the workspace sees it on the reports page) or private (only its owner does; it needs an owner)

Available options:
team,
private
widgets
ReportWidgetInput · object[]
Maximum array length: 50

Response

201 - application/json

Successful Response

created_at
string<date-time>
required
description
string | null
required
id
string
required
name
string
required

Unique across the workspace

owner
string | null
required

The owner's email: besides admins, only the owner can change it in the app. Null when it has no owner, or its owner is no longer a user

updated_at
string<date-time>
required
visibility
enum<string>
required

team (Public in the app: everyone in the workspace sees it on the reports page) or private (only its owner sees it there; admins can change it but don't see it listed). The API lists both

Available options:
team,
private
widgets
ReportWidget · object[]
required