Skip to content

List Org Streams

GET
/streams

List the organization’s tracking streams (websites) without a repository.

Streams belong to the organization, not to a connected repository, so this works even when the org has connected no repository. Each stream carries its write key, its domains, is_default (the stream GET /snippet uses when no stream_id is given), repo_id (the connected repository already using it, or null), and a read-only warning when it has no allowed domains.

Authorizations

Parameters

Query Parameters

page
Any of:
integer
>= 1

Page number (1-indexed). Omit page and limit to get every stream.

limit
Any of:
integer
>= 1 <= 200

Streams per page (max 200). Omit page and limit to get every stream.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
Array<object>
object
domains

Domains associated with this stream

Array<string>
domains_restricted

Whether the stream lists allowed domains. False means its public write key is accepted from any website (see warning).

boolean
id
required

Stream ID used to select this stream

string
is_default

True for the stream GET /snippet uses when no stream_id is given: the only stream, or the one whose domain matches the organization’s website. False on every stream when that choice is ambiguous; pass stream_id explicitly then.

boolean
name
required

User-friendly stream name (e.g. ‘graph8.com’, ‘heyreach-graph8’)

string
repo_id
Any of:
string
warning
Any of:
string
write_key
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string