firehose

Create a Firehose session

Changed on

Create a durable observed Firehose query when filters are too rich for URL parameters or a client needs stable live-session URLs.

Use this Firehose operation to query or observe source-backed civic signals for an authenticated workspace. Preserve workspace, usage, signal, and evidence context so billing and trust stay tied to the query that produced the data.

post/api/firehose/sessions

Request

  • Base URL: https://atlas.rebuildingus.org
  • URL: https://atlas.rebuildingus.org/api/firehose/sessions
  • Auth: none declared

Headers

Idempotency-Keystring nullable
Content-Typestring nullable
Acceptstring nullable
X-Request-IDstring nullable
Traceparentstring nullable
Tracestatestring nullable
Preferstring nullable
x-api-keystring nullable

Request body

Response

Successful Response

created_atstring required

created at for this firehose session.

events_urlstring required

events url for this firehose session.

expires_atstring required

expires at for this firehose session.

idstring required

id for this firehose session.

snapshot_urlstring required

snapshot url for this firehose session.

socket_urlstring required

socket url for this firehose session.

state'active' | 'expired' required

state for this firehose session.

Changes

  • 6ea72ce93d40Revision changes
    • warning

      deleted the header request parameter x-atlas-actor-email

    • warning

      deleted the header request parameter x-atlas-actor-id

    • warning

      deleted the header request parameter x-atlas-internal-secret

    • warning

      deleted the header request parameter x-atlas-organization-id

  • 5f6dc82dbd8eRevision changes
    • info

      endpoint added