Snapshots

List the snapshots of a report

Returns the snapshots of a report, newest first: what each one is, whether it has a file and what that file is called.

EVERY SNAPSHOT THAT HAS A FILE COMES WITH A SIGNED LINK. download_url opens the file with no Authorization header at all, which is what lets an assistant hand it to a person, and it stops working 900 seconds after this call (download_url_expires_at). It is null when the snapshot has no file, and a client that finds it null for one that does falls back to snapshot_key with the Bearer. A link is good for that one snapshot and cannot be revoked before it expires; list again for a fresh one. The file itself is served by GET /v1/snapshots/download.

The size of a file is NOT published: measuring it would mean loading it, and a listing of thirteen files is the one place that must not. The download answers Content-Length.

post/snapshots/list

Request

  • Base URL: https://api.reportingninja.com/v1
  • URL: https://api.reportingninja.com/v1/snapshots/list
  • Auth: HTTP bearer

Request body

report_keystring required

The report.

Response

The call succeeded. This endpoint reports its errors with a real HTTP status, so a 200 always carries status=ok.

status'ok' required

Changes

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