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>).

Query Parameters

report
string | null

report page slug from the report catalog; give this or setting_key.

Required string length: 1 - 80
sub_report
string
default:standard

sub-report slug of that page; standard when omitted.

Required string length: 1 - 80
setting_key
string | null

a setting key; give this or report.

Required string length: 1 - 80

Response

Successful Response

slots
Slots · object[]
required

each stored slot with its label, domain, default, current value and dependency.

setting_key
string | null

the setting key the page stores, or null when the page has no customizations.

status
string | null

customized or defaults.

pages
Pages · object[] | null

every report page the key drives, with the query that applies the saved values.

report
string | null

pages without customizations: the report page slug.

sub_report
string | null

pages without customizations: the sub-report slug.

name
string | null

pages without customizations: the display name.

markets
string[] | null

pages without customizations: the markets.

url
string | null

pages without customizations: the page in Edgeful.

note
string | null

pages without customizations: why there is nothing to describe.