Audience · StartupBuilder

Properties

Property	Type	Required	Description
`size`	`integer`		How many people match.

Inherited from Collection: 1 property

Property	Type	Required	Description
`query`	`json`		The saved query that defines a dynamic Collection.

Inherited from Thing: 4 properties

Property	Type	Required	Description
`id`	`string`	required	The stable identifier, which never changes.
`type`	list of Noun	required	The Nouns this Thing is an instance of.
`state`	`string`		The current state in its lifecycle.
`outside`	`json`		The ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.

Object

JSON

{
  "$id": "https://api.sb/tutorloop.com/audiences/audience_1",
  "$type": "Audience",
  "id": "Example id",
  "type": [
    "noun_1"
  ],
  "state": "Example state",
  "outside": {},
  "query": {},
  "size": 1
}

Relationships

An Audience is targeted by many Ads: an Ad is shown to the people its Audiences select. targetedBy, inverse targets.

Verbs

createCreates an Audience.
POST /{namespace}/audiencesdoAudience.created
getReturns one Audience by id.
GET /{namespace}/audiences/{id}readNo Event
listReturns Audiences, newest first, one page at a time.
GET /{namespace}/audiencesreadNo Event
updateChanges the given properties of an Audience.
PATCH /{namespace}/audiences/{id}doAudience.updated
deleteDeletes an Audience; its history is kept.
DELETE /{namespace}/audiences/{id}doAudience.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Audience.create`	Yes	Yes	Yes	No
`Audience.get`	Yes	Yes	Yes	Yes
`Audience.list`	Yes	Yes	Yes	Yes
`Audience.update`	Yes	Yes	Yes	No
`Audience.delete`	Yes	Yes	Yes	No

Call it

Text

Add an audience to QuietCopy with a noun.

Example

The Audience of trial users with no API call in 7 days feeds a reminder Message each morning. It drops anyone who becomes a Customer.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link