Expression Measurement APIRuns

List runs

Your organization's runs, newest first, one page at a time. The filters combine.

Authentication

X-Hume-Api-Keystring
API Key authentication via header

Query parameters

page_sizeintegerOptional1-200Defaults to 50
How many runs to return.
cursorstringOptional

The next_cursor of the previous page. Pass it back unchanged.

user_idstringOptional
Only runs made by this user.
statusenumOptional
Only runs with this status.
Allowed values:
modeenumOptional
Only runs that reached the API this way.
Allowed values:
endpointenumOptional
Only runs that measured this kind of media.
Allowed values:
started_beforedatetimeOptional
Only runs that started before this time, in RFC 3339 format.
started_afterdatetimeOptional
Only runs that started at or after this time, in RFC 3339 format. Consecutive time ranges that share a boundary neither skip a run nor return one twice.

Response

One page of runs.
runslist of objects
The runs, newest first.
run_idstringformat: "uuid"

The run’s ID: the session_id of a realtime session, or the run_id of a file response.

user_idstring
The ID of the Hume user who made the run.
statusenum

Where a run is in its life: live while it is in progress, ended once it completed, and errored if it ended because of a failure or because the connection was lost. A live run the server has not heard from in five minutes is also reported errored, and reads live again if the server hears from it.

Allowed values:
endpointenum
What the run measured.
Allowed values:
modeenum
How the media reached the API.
Allowed values:
started_atdatetime
When the run started.
ended_atdatetime or null

When the run ended. Null while it is in progress. For a run reported errored because the server stopped hearing from it, the last time the server heard from it.

bytes_receivedinteger or null

Bytes of media the server took in. A realtime video frame counts once it passes the send-rate check, even if it is then rejected as invalid. Null until the run ends, and for a run whose end was never recorded.

bytes_recordedinteger or null
How far the server got in storing the run's media, in bytes. Media that could not be stored is included, so this can exceed what was kept. Null when the run's media was not being stored, or when the server has not reported how much it stored, as early in a live run.
metered_secondsdouble>=0

Billable seconds for the run. For audio, this is the duration of the audio the server took in. For video, each frame or image the server took in counts as one third of a second, regardless of frame rate, including a realtime frame rejected as invalid after it passed the send-rate check. A run that took in any media is billed at least 10 seconds, applied when the run ends. Updated while a realtime run is in progress. A file request that fails is not billed, and a run recorded for it reports 0.

next_cursorstringOptional

Absent on the last page. Pass it back as cursor for the next one.

Errors

400
Bad Request Error
401
Unauthorized Error
405
Method Not Allowed Error
500
Internal Server Error
503
Service Unavailable Error