brands

One brand, with its pipeline health

Counts, the engines the plan measures, and the health block: last successful cycle, next scheduled cycle, run success rate, log-ingest continuity, connection states. Read this before treating a flat metric as a signal.

get/brands/{brandId}

Request

  • Base URL: https://shruwd.io/api/v1
  • URL: https://shruwd.io/api/v1/brands/{brandId}
  • Auth: HTTP bearer

Response

The brand.

brandIdstring required
role'viewer' | 'editor' | 'admin' | 'owner' required

The caller's role on this brand: owner for the workspace's owner, else the role they were given on it. Reads need viewer, writes editor.

slugstring required

The URL handle: the dashboard is at /brands/{slug}. From the name at creation; stable across renames; accepted wherever {brandId} is.

namestring required
domainstring required

Registrable domain, lowercase.

timezonestring required

IANA zone; day boundaries for cycles and rollups.

createdAtstring date-time required
activePromptsinteger required
competitorsinteger required
enginesEngine[] required

The engines the plan measures for this brand.

Changes

No recorded changes to this operation across all 1 revision of this API.