Read observed ingress state and published media
GET
cookie
vg_session<token>The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.
orgId*stringAuthorised orgId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthprojectId*stringAuthorised projectId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthAuthorised read result. Null means unreported, never zero. Source-specific coverage limits remain visible.
application/json- response
source*stringingress*array<>sourceStatus?How fresh a sampled read is. Present when the worker samples the layer; a layer never read successfully answers 503 source_unavailable instead.
Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/ingress'Example Response
{ "source": "string", "ingress": [ { "id": "string", "name": "string", "inputType": "string", "url": "string", "room": "string", "participant": "string", "transcoding": true, "reusable": true, "enabled": true, "status": "string", "error": "string", "startedAt": "2019-08-24T14:15:22Z", "endedAt": "2019-08-24T14:15:22Z", "audioIn": { "mimeType": "string", "averageBitrate": 0, "channels": 0, "sampleRate": 0 }, "videoIn": { "mimeType": "string", "averageBitrate": 0, "width": 0, "height": 0, "framerate": 0 }, "createdAt": "2019-08-24T14:15:22Z", "published": [ { "type": "string", "mimeType": "string", "source": "string" } ], "history": [ { "at": "2019-08-24T14:15:22Z", "status": "string" } ] } ], "sourceStatus": { "lastReadAt": "2019-08-24T14:15:22Z", "lastGoodReadAt": "2019-08-24T14:15:22Z", "errorClass": "unauthenticated" }}Was this page helpful?