Import Runs

List import runs (admin)

Admin only. Newest first, paginated. A partner reads its own run through GET /v1/import_runs/{id}, which is HMAC-authenticated.

get/v1/admin/import_runs

Request

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

Query parameters

status'open' | 'in_progress' | 'completed' | 'failed' | 'staged'

Rejected with 422 if unrecognised, rather than silently returning every run.

kindstring

Not validated — an unknown kind returns an empty list.

pageinteger
per_pageinteger

Response

List of import runs

idstring uuid
source'partner_api' | 'retool_upload'

partner_api: sent by the partner's signed feed. retool_upload: submitted by ops from Retool on the partner's behalf.

kindstring

Free-form; grows with each importer. e.g. tournament_import

status'open' | 'in_progress' | 'completed' | 'failed' | 'staged'
partner_integration_idinteger nullable
importable_typestring nullable
importable_idstring uuid nullable
row_countinteger nullable
processed_countinteger
approval_mappingsobject

Ids ops attached when approving, e.g. a tournament_id uuid.

summaryobject
pending_mappingsstring[]

Lifted out of summary. What a staged run is waiting for ops to attach.

error_detailsobject[]
initiated_by_idstring uuid nullable
started_atstring date-time nullable
finished_atstring date-time nullable
created_atstring date-time
updated_atstring date-time

Changes

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