Skip to main content
GET
Get one product and its dimensions

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.

Path Parameters

product_id
string
required

Response

200 - application/json

Successful Response

id
string
required
name
string
required

Unique across the workspace

date_column
string | null

The column usage dates come in, in a data feed

date_format
enum<string> | null

The format usage dates are written in; null when not set or not one this API knows

Available options:
%Y-%m-%d,
%m/%Y,
%Y,
%m-%Y,
%Y/%m/%d,
%d/%m/%Y,
%m/%d/%Y,
%Y-%m
dimensions
Dimension · object[]

In the order the app shows them

display_name
string | null
period
enum<string> | null

The period its usage is reported for; usage written at another period does not show. Null when not set (the app reads it as MONTHLY) or not one this API knows

Available options:
DAILY,
WEEKLY,
MONTHLY,
QUARTERLY,
YEARLY,
SINGLE
show_if_empty
boolean | null

Whether the app shows it on an account with no usage; null when not set, so it follows the workspace's setting (shown, unless the workspace changed it)