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

Audience routes: create, get, list

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

Reference for Audience, one group of Audience routes.

Audience.create

Creates an Audience. Verb page.

Text
POST /{namespace}/audiences

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

Inputs

InputTypeRequiredDescription
idstringThe stable identifier, which never changes.
typelist of NounThe Nouns this Thing is an instance of.
outsidejsonThe ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.
queryjsonThe saved query that defines a dynamic Collection.
sizeintegerHow many people match.

Returns

OutputTypeRequiredDescription
audienceAudiencerequiredThe Audience.

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/audiences \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"audience_vmVkEYrXCN"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "audience": {
    "$id": "https://api.sb/leaseline.app/audiences/audience_vmVkEYrXCN",
    "$type": "Audience",
    "id": "Example id",
    "type": [
      "noun_v0akLUrXCN"
    ]
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Audience.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Audience.get

Returns one Audience by id. Verb page.

Text
GET /{namespace}/audiences/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
audienceAudiencerequiredThe Audience.

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/audiences/audience_vmVkEYrXCN \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Audience",
  "$id": "https://api.sb/leaseline.app/audiences/audience_vmVkEYrXCN",
  "audience": {
    "$id": "https://api.sb/leaseline.app/audiences/audience_vmVkEYrXCN",
    "$type": "Audience",
    "id": "Example id",
    "type": [
      "noun_v0akLUrXCN"
    ]
  },
  "links": {
    "self": "https://api.sb/leaseline.app/audiences/audience_vmVkEYrXCN",
    "up": "https://api.sb/leaseline.app/audiences"
  }
}

Audience.list

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

Text
GET /{namespace}/audiences

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
audienceslist of AudiencerequiredOne page of Audiences.

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

Audience

Previous

update, delete

Next