Profit report

GET /v1/reports/profit

Monthly revenue, production cost, cost of failure and per-SKU margin.

Requires: analytics.view

Query Parameters

month required

string

YYYY-MM, interpreted in the store's timezone.

Response Schema

ProfitReport

caveatsrequired

any[]

costOfFailurerequired

object

attemptsrequired

number

costrequired

number

gramsrequired

number

hoursrequired

number

costsrequired

object

filamentCostrequired

number

filamentGramsrequired

number

laborCostrequired

number

machineCostrequired

number

machineHoursrequired

number

machineRaterequired

number

totalrequired

number

currencyrequired

string

marginBySkurequired

object[]

costrequired

number

marginPctrequired

number

revenuerequired

number

skuIdrequired

string

skuNamerequired

string

unitsrequired

number

monthrequired

string

revenuerequired

object

bySourcerequired

object[]

amountrequired

number

ordersrequired

number

sourcerequired

string

totalrequired

number

timezonerequired

string

Example Response

200 OK — application/json

{
  "month": "string",
  "timezone": "string",
  "revenue": {
    "total": 1,
    "bySource": [
      {
        "source": "string",
        "amount": 1,
        "orders": 1
      }
    ]
  },
  "costs": {
    "filamentGrams": 1,
    "machineHours": 1
  },
  "costOfFailure": {
    "grams": 1,
    "hours": 1,
    "attempts": 1
  },
  "marginBySku": [
    {
      "skuId": "string",
      "units": 1,
      "revenue": 1
    }
  ],
  "caveats": []
}