For AI agents: a documentation index is available at https://docs.coverbase.com/llms.txt. This page is also available in markdown by appending .md to the URL.
Export Report
GET
GET /v1/export/{slug}ak_ API key (see Authentication).
Path parameters
string
required
The report’s slug, as set on the report in the dashboard. It is also returned as
slug.Query parameters
integer
The maximum number of JSON objects to return in the
data array.integer
The number of records to skip before starting to return data.
string
Case-insensitive substring filter on the supplier/vendor name. Applies to
vendor-based reports (for example, the all-suppliers report); ignored for
other base objects.
total_count reflects the filtered result.integer
For
radar_run reports only: include runs that started at or after this Unix timestamp (seconds). Ignored for other base objects.integer
For
radar_run reports only: include runs that started before this Unix timestamp (seconds). Ignored for other base objects.limit or offset returns 400. An unknown slug returns 404 with {"detail": "Export report not found"}.
Example request
Example response
Response fields
string
Unique Coverbase export report ID.
string
Unique string used in the API endpoint URL.
string
Display name for the report.
string
The object each record in
data represents (for example, vendor or assessment).object
Mapping between Coverbase field names and the field names exported in the JSON objects.
array
Array of JSON objects. Each object represents one
base_object and contains field names specified by the values in the mapping object.integer
The maximum length of the
data array.integer
The number of records skipped before the system began returning records.
integer
Total number of records the report matches, before
limit and offset.Download a report as a file
GET
GET /v1/export/{slug}/downloadvendor-custom-report.csv).
string
default:"csv"
csv or xlsx.limit, offset, supplier_name, start_ts, and end_ts parameters work as above. One request returns at most 100,000 rows; page with limit and offset for larger reports.
cURL
Need help? Email support@coverbase.ai.