reports

Poll a report job

get/api/v1/reports/{id}

Request

  • Base URL: https://jointhestudentlife.com
  • URL: https://jointhestudentlife.com/api/v1/reports/{id}
  • Auth: none required

Path parameters

idstring required

Job id from createReport.

Response

Job status, with the result once succeeded.

idstring required

Job id. Opaque: pass it back unchanged.

type'city_comparison' | 'events_overview' required
status'pending' | 'succeeded' required

pending right after POST; succeeded when polled. The report is built from the data at the moment you poll.

created_atstring date-time
expires_atstring date-time

24 hours after creation. Polling after that gets 410.

completed_atstring date-time
status_urlstring uri required

Where to poll. Same as the Location header.

poll_after_secondsinteger
data_updatedstring
resultobject

Present when status is succeeded. city_comparison: {cities: [...]}. events_overview: {total, by_type, by_ticket_status, events: [...]}.

notestring

Changes

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