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

Ad routes: create, get, list

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

Reference for Ad, one group of Ad routes.

Ad.create

Creates an Ad. Verb page.

Text
POST /{namespace}/ads

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

Inputs

InputTypeRequiredDescription
formatstringrequiredOne of search, display, image, or video.
spendmoneyWhat it has cost so far.
campaignCampaignA Campaign places Ads that share its budget and window.
offerOfferEach Ad sells one Offer.

Returns

OutputTypeRequiredDescription
adAdrequiredThe Ad.

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/ads \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format":"search"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "ad": {
    "$id": "https://api.sb/leaseline.app/ads/ad_yVW4IAmeOW",
    "$type": "Ad",
    "format": "search"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Ad.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Ad.get

Returns one Ad by id. Verb page.

Text
GET /{namespace}/ads/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
adAdrequiredThe Ad.

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/ads/ad_yVW4IAmeOW \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Ad",
  "$id": "https://api.sb/leaseline.app/ads/ad_yVW4IAmeOW",
  "ad": {
    "$id": "https://api.sb/leaseline.app/ads/ad_yVW4IAmeOW",
    "$type": "Ad",
    "format": "search"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/ads/ad_yVW4IAmeOW",
    "up": "https://api.sb/leaseline.app/ads"
  }
}

Ad.list

Returns Ads, newest first, one page at a time. Verb page.

Text
GET /{namespace}/ads

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
adslist of AdrequiredOne page of Ads.

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/ads?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Ad",
  "ads": [
    {
      "$id": "https://api.sb/leaseline.app/ads/ad_yVW4IAmeOW",
      "$type": "Ad",
      "format": "search"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "ad_yVW4IAmeOW"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/ads?limit=20",
    "next": "https://api.sb/leaseline.app/ads?after=ad_yVW4IAmeOW"
  }
}

Ad

Previous

update, delete

Next