Public Event Pages

Chirpier exposes hosted public event pages at https://www.chirpier.co/events/:eventId?share=:shareToken for shareable events.

To make an event publicly accessible, update the event definition to set public: true. Chirpier auto-generates a share_token when the event is created — you use this token alongside the event_id for public access.

JavaScript


const event = await client.getEvent(eventID);
 
// Make the event public
await client.updateEvent(eventID, { public: true });
 
// The share_token is available on the event definition
const shareURL = `https://www.chirpier.co/events/${event.event_id}?share=${event.share_token}`;

Python


event = client.get_event(event_id)
 
# Make the event public
client.update_event(event_id, {"public": True})
 
# The share_token is available on the event definition
share_url = f"https://www.chirpier.co/events/{event['event_id']}?share={event['share_token']}"

Go


event, _ := client.GetEvent(ctx, eventID)
 
// Make the event public
client.UpdateEvent(ctx, eventID, map[string]any{"public": true})
 
// The share_token is available on the event definition
shareURL := fmt.Sprintf("https://www.chirpier.co/events/%s?share=%s", event.EventID, event.ShareToken)

Raw API


# Get the event to find its share_token
curl "https://api.chirpier.co/v1.0/events/$EVENT_ID" \
  -H "Authorization: Bearer $CHIRPIER_API_KEY"
 
# Make it public
curl -X PUT "https://api.chirpier.co/v1.0/events/$EVENT_ID" \
  -H "Authorization: Bearer $CHIRPIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"public": true}'

Public dashboard page

Public access uses both:

event_id
share_token

That pair is required for hosted public reads. Share the URL directly or use it as the basis for embedded charts.

What the hosted page supports

Range selection: 1h, 1d, 1w, 1m
Compare mode: overlay the previous period for visual comparison
Chart variants: line and bar
Summary and tracker views
Embedded mode with header suppression

Embedding the public page

Both @chirpier/charts (React) and @chirpier/embed (framework-agnostic) use the hosted public page as the runtime surface. They render it in an iframe and communicate via postMessage.

To embed a chart, you need the eventId and shareToken from the event definition:


<ChirpierChart
  eventId="your-event-id"
  shareToken="your-share-token"
  range="1d"
  compare
  view="timeseries"
  variant="line"
/>

For full embed usage, see React or Framework-Agnostic.