HIhify
Order Requests

List Order requests

get/v1/order_requests

Request

  • Base URL
    https://api.hify.club
  • Auth
    API key in header X-User-Token

Query parameters

pageinteger
per_pageinteger
status'open' | 'in_progress' | 'in_review' | 'done' | 'archived'
facility_idstring
arena_idstring
start_datestring
idstring
typestring
string
OR
string[]

Filter by stage group. Accepts a single value or an array; unknown values return no rows.

assigneestring

Filter by the current human owner's email, or the literal unassigned.

highlight_bundle_statusstring

Filter by the status of an associated highlight moment bundle.

highlight_bundle_assigned_tostring

Filter by the editor assigned on a non-terminal highlight moment bundle.

Response

List of order requests

distinct_typesstring[] required
attention_summaryobject required

Row counts per attention_state group for the ops-board tiles. Computed on the filtered scope before pagination, ignoring the attention_state filter itself; rows with no stage are excluded.

attention_filter_optionsstring[] required

Every attention_state group, for building the filter's option list.

stuck_statesstring[] required

The subset of groups meaning "stopped, needs a human".

Example response

{
  "order_requests": [
    {
      "assignee": "priya@hify.club",
      "processing_message": "Delivered 3/12 segments (camera 12); watching for the rest"
    }
  ],
  "distinct_types": [
    "HighlightRequest",
    "ReplayRequest",
    "ShortRequest"
  ],
  "attention_summary": {
    "annotating": 7,
    "ready_to_bundle": 3,
    "needs_editor": 2,
    "in_review": 4,
    "stuck": 1
  },
  "stuck_states": [
    "stuck"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.