Exports

Poll an export job

The current state of an export job. Status moves queued, then running, then completed; a completed job carries result.url pointing at the finished artifact. Poll no faster than the Retry-After hint on the previous response.

get/exports/{job_id}

Request

  • Base URL: https://yappy.biz/api/v1
  • URL: https://yappy.biz/api/v1/exports/{job_id}
  • Auth: one of:
    • none
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://yappy.biz/oauth/authorize, token URL https://yappy.biz/oauth/token; client credentials, token URL https://yappy.biz/oauth/token, scopes: export:docs)

Path parameters

job_idstring required

Job identifier from the createExport response.

Response

The job's current state

object'job' required

Type discriminator.

idstring required

Job identifier.

status'queued' | 'running' | 'completed' | 'failed' required

Where the job is now.

resourcestring required

What is being exported.

formatstring

The artifact format.

created_atstring date-time

When it was accepted.

poll_urlstring uri required

Where to poll this job.

retry_afterinteger

Seconds to wait before polling again.

errorobject nullable

Present once status is failed.

Changes

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