Skip to content

Add get session endpoint #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add get session endpoint #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/rest-api/dispatch/get-session.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,21 @@ authMethod: "bearer"
2006-01-02T15:04:05Z07:00). `null` if the session hasn't terminated yet.
</ResponseField>

<RequestExample>
<ResponseField name="participant_duration_secs" type="int or null">
The sum of participant connection times, expressed in seconds.
`null` if the session hasn't terminated yet.
</ResponseField>

<ResponseField name="offline_duration_secs" type="int or null">
The number of seconds elapsed where the session was online, but no participants were connected.
`null` if the session hasn't terminated yet.
</ResponseField>

<RequestExample>
```bash cURL
curl -H 'Authorization: Bearer <your-api-key>' \
https://engine.hyperbeam.com/v0/vm/<session_id>
```

</RequestExample>

<ResponseExample>
Expand All @@ -54,7 +62,9 @@ curl -H 'Authorization: Bearer <your-api-key>' \
"embed_url": "https://96xljbfypmn3ibra366yqapci.hyperbeam.com/AAEjQFOIRnyeb81XbBsHMw?token=VTWsp1KGn4lLySRkUCmmAhsCcqJrPdhTXNS0Y-KPwHU",
"admin_token": "DrXWd9QguPRSXwhQn4yJ66sExpoV0BZtAfZsseYECKo",
"creation_date": "2025-01-02T15:04:05Z07:00",
"termination_date": null
"termination_date": null,
"participant_duration_secs": null,
"offline_duration_secs": null
}
```

Expand Down