intelligence

Export the report as a file

Returns the same report as GET /intelligence/report, serialized to a downloadable file instead of JSON. The response body is the file itself, with a Content-Disposition attachment header and a dated filename.

Export formats follow the plan: Starter has none and receives 403, Pro can export CSV, Business can export CSV and PDF.

A successful export consumes one unit of the daily quota, the same as a report call. If the underlying data is older than 24 hours the endpoint returns 503 with a Retry-After header.

get/api/v1/intelligence/report/export

Request

  • Base URL: https://api.gatiflow.io
  • URL: https://api.gatiflow.io/api/v1/intelligence/report/export
  • Auth: API key in header X-API-Key

Query parameters

formatstring

File format: csv on Pro and Business, pdf on Business.

Headers

X-API-Keystring nullable

The API key, prefix gf_: the credential the ApiKeyAuth scheme declares.

Response

The report as a file attachment. Content-Type follows the requested format.

Changes

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