getStream
HTTP Request
GET /readStreams/:streamIdPath parameters
streamId
The id of the stream to consume, as returned in the ReadSession.post response.
Query parameters
offset
Optional. Used for resuming interrupted streams.
If specified, will start reading the stream at the provided numeric offset. Note that you cannot provide an offset beyond what has already been read from the stream.
Authorization
By default, only the user who created the stream's read session can consume its streams. If the data in the stream is not public, your access token must have one of the following scopes:
data.data
data.edit
However, if the stream's readSession was created with the allowAnonymousAccess option, no authorization is required.
Learn more about authorization.
Request body
The request body must be empty.
Response body
The response body contains the streams data, in the format specified by the ReadSession.post request:
Arrow data is returned in the binary Arrow IPC Stream formatThe response is returned in the JSON Lines format, with each row represented as an object of key:value pairs.
// e.g.: ...table_ref/rows?selectedVariables=id,date,decimal,text
{"id":1, "date":"2012-01-01", "decimal":4.2, "text":"Some text"]
{"id":2, "date":"2012-01-01", "decimal":3.14, "text":"More text"]
...Please note the following regarding response data formats:
Date variables are formatted as
YYYY-MM-DDDateTime variables are formatted at
YYYY-MM-DD HH:MM:SS[.DDDDDD]Time variables are formatted as
HH:MM:SS[.DDDDDD]Geography variables are formatted as well-known text (WKT)
The response is returned as a comma-separated file.
// e.g.: table_ref/rows?format=csv&selectedVariables=id,date,decimal,text
"1","2012-01-01","4.2","Some text"
"2","2012-02-02","3.14","Some other text"
"3", ...Please note the following regarding response data formats:
Date variables are formatted as
YYYY-MM-DDDateTime variables are formatted at
YYYY-MM-DD HH:MM:SS[.DDDDDD]Time variables are formatted as
HH:MM:SS[.DDDDDD]Geography variables are formatted as well-known text (WKT)
Last updated
Was this helpful?