Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthDemand Budget

Demand Budget routes: create, get, list

The Demand Budget Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Demand Budget, one group of Demand Budget routes.

DemandBudget.create

Creates a Demand Budget. Verb page.

Text
POST /{namespace}/demand-budgets

Body, as JSON: the inputs. Emits DemandBudget.created.

Inputs

InputTypeRequiredDescription
amountmoneyrequiredThe monthly spend it funds; zero is the default.
tierstringrequiredOne of $0, $100, $1k, $10k or $100k: the highest tier at or below the amount, whose Play mix it buys.
targetstringrequiredThe Metric value the spend must reach, such as cost per first Order under $40.
stopRulestringrequiredThe reading that closes the budget, such as acquisition cost above margin for two weeks.
untildateThe last day the budget runs before its Decision is read.

Returns

OutputTypeRequiredDescription
demandBudgetDemand BudgetrequiredThe Demand Budget.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/demand-budgets \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":{"amount":29,"currency":"USD"},"tier":"$0","target":"Example target","stopRule":"Example stop rule"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "demandBudget": {
    "$id": "https://api.sb/leaseline.app/demand-budgets/demand_zQZUG08LwY",
    "$type": "DemandBudget",
    "amount": {
      "amount": 29,
      "currency": "USD"
    },
    "tier": "$0",
    "target": "Example target",
    "stopRule": "Example stop rule"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "DemandBudget.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

DemandBudget.get

Returns one Demand Budget by id. Verb page.

Text
GET /{namespace}/demand-budgets/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Demand Budget.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
demandBudgetDemand BudgetrequiredThe Demand Budget.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/demand-budgets/demand_zQZUG08LwY \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "DemandBudget",
  "$id": "https://api.sb/leaseline.app/demand-budgets/demand_zQZUG08LwY",
  "demandBudget": {
    "$id": "https://api.sb/leaseline.app/demand-budgets/demand_zQZUG08LwY",
    "$type": "DemandBudget",
    "amount": {
      "amount": 29,
      "currency": "USD"
    },
    "tier": "$0",
    "target": "Example target",
    "stopRule": "Example stop rule"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/demand-budgets/demand_zQZUG08LwY",
    "up": "https://api.sb/leaseline.app/demand-budgets"
  }
}

DemandBudget.list

Returns Demand Budgets, newest first, one page at a time. Verb page.

Text
GET /{namespace}/demand-budgets

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
demandBudgetslist of Demand BudgetrequiredOne page of Demand Budgets.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/demand-budgets?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "DemandBudget",
  "demandBudgets": [
    {
      "$id": "https://api.sb/leaseline.app/demand-budgets/demand_zQZUG08LwY",
      "$type": "DemandBudget",
      "amount": {
        "amount": 29,
        "currency": "USD"
      },
      "tier": "$0",
      "target": "Example target",
      "stopRule": "Example stop rule"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "demand_zQZUG08LwY"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/demand-budgets?limit=20",
    "next": "https://api.sb/leaseline.app/demand-budgets?after=demand_zQZUG08LwY"
  }
}

Demand Budget

Previous

update

Next