Case actions

Status of one case evidence pack

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

get/projects/{project_id}/evidence-packs/{pack_id}

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/projects/{project_id}/evidence-packs/{pack_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.

pack_idstring required

The pack id from create_case_evidence_pack.

Response

Status of one case evidence pack

idstring required
case_type'policy' | 'affiliate' required
status'queued' | 'running' | 'ready' | 'failed' | 'expired' required

queued and running: still generating. ready: download it. failed: see error. expired: request it again.

time_zonestring required

Times in the PDF are shown in this time zone.

requested_atstring required
completed_atstring nullable required
expires_atstring required

When a ready pack'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.