Get terminal streams

GET

/terminals/{id}/streams

curl --request GET \
  --url 'https://legion.picogrid.com/v2/terminals/example/streams?paging_direction=forwards'

• The server that hosts the Legion prod API

Gets all streams for the specified terminal paginated

Parameters

Path Parameters

id

required

string

The id of the terminal you want to get streams for

Query Parameters

limit

string

The maximum number of items to return with a default value of 10. Note that a request never returns more than about 1MB of data irrespective of how high this value is

cursor

string

The cursor given by your previous request used to get the next page of results. Defaults to start from the beginning if forwards and end if backwards

paging_direction

string

Allowed values: forwards backwards

The direction for the pagination cursor. Defaults to forwards

org_id

string

The id of the organization to get terminal streams for

Responses

200

Success

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string

terminal_id

required

string

fragment_type_id

required

string

processor_ids

required

The ids of the processors you have instantiated for your organization and attached to this stream. Picogrid offers several different types of processing for different data streams such as object detection on image/jpg type streams

Array<string>

last_edited

required

Epoch milliseconds integer. See https://en.wikipedia.org/wiki/Unix_time for more information

integer

compatible_namespaces

required

The namespaces compatible with this stream. Namespaces define the commands available for a stream. For instance, the FLIR namespace enables users to perform PTZ commands on a FLIR camera.

Array<string>

pagination

required

One of:

No More Pages

No More Pages

object

has_more

required

Is false in this case which means you have reached the end of available results

boolean

More Pages

More Pages

object

has_more

required

Is true in this case which means there are more pages to be fetched

boolean

cursor

required

The cursor specifying your current pagination progress used to fetch next pages. Is only present if has_more is true

string

Example

{
  "pagination": {
    "has_more": false
  }
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

400

Bad Request Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

401

Authentication Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

403

Unauthorized Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

404

Resource Not Found Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

408

Timeout Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

500

Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

502

Bad Gateway Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link