Get a signal bucket

Retrieves one signal bucket by key, with the IDs of the signals it groups and what your workspace pays for it.

Use the key returned by List signal buckets — essential, standard or advanced. It is the same in every environment.

A bucket's price is per key account, per month: you pay for the accounts on any list you've assigned to that bucket, not for each signal it detects. If your workspace is attached to a partner with a negotiated rate, pricing reflects that rate instead of the standard one.

Route

GET/api/v3/signal-buckets/{key}

Access modes

Use a workspace API key. The workspace is inferred from the key.

Authorization: Bearer sk_live_...

Path parameters

Parameter	Type	Description
key	string	The key of the bucket — `essential`, `standard` or `advanced`.

Example request

curl "https://api.getsillage.com/api/v3/signal-buckets/advanced" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Success response

Status: 200 OK

{
  "data": {
    "key": "advanced",
    "name": "Advanced signals",
    "description": "Everything in Essential and Standard, plus competition, champion and partner signals.",
    "display_order": 3,
    "signal_template_ids": [7, 12, 15],
    "pricing": { "credits": 150, "unit": "key_account_per_month" }
  }
}

Response fields

Field	Type	Description
data.key	string	Stable identifier of this bucket, the same in every environment — `essential`, `standard` or `advanced`.
data.name	string	The bucket name shown to a user.
data.description	string or null	A short explanation of what this bucket is for.
data.display_order	integer	The position this bucket should be shown at, ascending.
data.signal_template_ids	array of integer	The IDs of the signals grouped in this bucket.
data.pricing	object or null	What your workspace pays for this bucket. `null` when no price has resolved for your workspace yet.
data.pricing.credits	number	The exact price, in credits — never rounded.
data.pricing.unit	string	Always `key_account_per_month` — you're billed per key account, per month.

pricing: null means no price has resolved for your workspace on this bucket — it is not the same as free. Do not treat a missing price as a signal that the bucket costs nothing.

Errors

Status	Meaning
400	`key` is invalid.
401	The API key is missing or invalid.
404	No bucket matches this key.
429	Rate limit exceeded.
500	An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json. type is always about:blank on v3 — title is what tells one problem from another:

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "Signal bucket not found",
  "instance": "/api/v3/signal-buckets/no-such-key"
}