Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).

Path Parameters

definition_id
string<uuid>
required

the saved custom report's id, from the list.

Response

Successful Response

status
string
required

running, the run's outcome such as succeeded or failed, or no_result when the report has no successful run.

definition_id
string
required

saved custom report id.

run_id
string | null

the run that produced the result.

message
string | null

a note about the run.

effective_controls
any | null

the inputs the run actually used.

data_through
string | null

the last date the data covers.

computed_at
string | null

when the run finished.

retryable
boolean | null

whether a failed run may be retried.

retry_after_seconds
integer | null

seconds to wait before retrying.

poll_after_seconds
number | null

while running: seconds to wait before reading the run again.

route_to_refine
any | null

where to refine the report.

summary
any | null

the result's summary values.

detailed_data
any[] | null

the result's rows, every one the run stored.

total_rows
integer | null

rows in the result.

truncated
boolean | null

true when the response does not carry every row.

column_units
any | null

units per column.

row_label
any | null

what a row represents.

row_grain
any | null

the row grain.

presentation
any | null

presentation hints.

url
string | null

the report in Edgeful.