Download the file of a snapshot
Returns the file of a snapshot. It is one of the TWO endpoints of this API that are a GET, whose success is not a JSON envelope and that have no MCP tool of their own; the other one is GET /v1/language-files/download.
TWO WAYS IN, AND ONE OF THEM IS ENOUGH (a request that carries both is served by the token). token is the signed link /v1/snapshots/list publishes as download_url: it carries the account and the snapshot inside it, needs NO Authorization header -- which is what lets an assistant hand the link to a person -- and expires 900 seconds after it was minted. snapshot_key is the form a script uses, with the Bearer of the account; it is charged against the read rate limit like any other call.
The response is the file itself, application/pdf or application/vnd.ms-excel according to the name it was stored under, with a Content-Disposition attachment whose filename is that name reduced to ASCII. The signed form has a budget of its own, much narrower than the read rate limit: a link is good for a handful of downloads a minute, which is what handing a file to somebody takes and not what mirroring an account takes. Everything that is not a file comes back in the envelope of the rest of the API: 400 when neither token nor snapshot_key was sent, 401 with no credentials, 404 when the link expired, the snapshot is gone, it belongs to another account or its execution filed no file, and 429 over the rate limit. A POST to this path is ENDPOINT_NOT_FOUND, and a HEAD is 405.
Request
- Base URL: https://api.reportingninja.com/v1
- URL: https://api.reportingninja.com/v1/snapshots/download
- Auth: one of:
- HTTP bearer
- none
Query parameters
The signed link of one snapshot, as /v1/snapshots/list published it. No Authorization header is needed with it. The whole URL is published ready to use: it is this base plus this path, and nothing has to be assembled.
The snapshot, from /v1/snapshots/list. Requires the Bearer of the account.
Response
The file.
Changes
No recorded changes to this operation across all 1 revision of this API.