Skip to main content
GET
Get Live Banner
Returns the announcement banner currently live for a project — the one-line bar (badge, headline, one-sentence body, call-to-action) that the embed widget shows at the top of a site. Exactly one banner is live per project: publishing a new one replaces it. With an API token the response is your project’s banner. Without a token it is Shipstar’s own (what shipstar.ai renders above its nav). A 404 means no banner is live — never published, replaced, or past its take-down time — and is the normal empty state, not an error: render nothing. Send X-Shipstar-Page-Url with the page you render it on so your dashboard’s “Published” status links there.

Request

Response

string
The stable embed key (data-shipstar-key). It does not change when a new banner replaces the old one.
string
At most 80 characters.
string
One sentence on the benefit, at most 160 characters. The widget hides it on narrow screens.
string
Call-to-action label, at most 24 characters.
string
Short tag to show before the headline, at most 16 characters — "New" unless the banner re-worded it. An empty string means the banner has no badge: render nothing.
Where the call-to-action points. null means the banner has no link — omit the button.
string | null
The commit window the banner was generated from (YYYY-MM-DD).
string | null
ISO-8601. Changes with every publish; use it as a cache key or a “seen” marker.
string | null
When the banner stops being served, if a take-down was set on the schedule. The API already stops serving it then; respect it if you cache longer.
integer | null
Provenance: how many commits the banner was generated from.

Example Response

200

Errors