Reports

Status of one PDF report

Returns one report's status. Reports usually take less than a minute; poll every few seconds while it is queued or running. A failed report has an error with a message to show the person.

get/projects/{project_id}/reports/{report_id}

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/projects/{project_id}/reports/{report_id}
  • Auth: HTTP bearer

Path parameters

project_idstring required

The project: its id, its brand domain (for example nike.example) or its exact project or brand name. Unknown or ambiguous references return not_found; call list_projects then.

report_idstring required

The report id from create_report or list_reports.

Response

Status of one PDF report

idstring required
project_idstring required
status'queued' | 'running' | 'ready' | 'failed' | 'expired' required

queued and running: still generating. ready: download it. failed: see error. expired: the file was deleted; request it again.

requested_atstring required
completed_atstring nullable required
expires_atstring required

When a ready report's file is deleted, 7 days after it was generated.

page_countinteger nullable required
size_bytesinteger nullable required
request_idstring

Changes

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