> ## Documentation Index > Fetch the complete documentation index at: https://edgeful.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # describe report customizations > describe a report page's customizations (what its customization modal edits) by report and sub_report, or by setting_key: each slot's stored key, label, domain, default, current value and the slot or page control that activates it, plus every page the setting key drives with the query that makes a report endpoint apply the saved values. works with writes off. ## OpenAPI ````yaml /openapi-public.json get /v1/settings/report-customizations openapi: 3.1.0 info: title: Edgeful API description: >- Public API reference for Edgeful market analysis. The bearer token is your Edgeful API key. Reports support the docs playground. Report responses include row-level output in `detailed` only when your plan includes row-level detail. version: 1.0.0 servers: - url: https://api.edgeful.com description: Production security: - BearerAuth: [] tags: - name: reports - name: discovery - name: live data - name: settings - name: custom reports paths: /v1/settings/report-customizations: get: tags: - settings summary: describe report customizations description: >- describe a report page's customizations (what its customization modal edits) by report and sub_report, or by setting_key: each slot's stored key, label, domain, default, current value and the slot or page control that activates it, plus every page the setting key drives with the query that makes a report endpoint apply the saved values. works with writes off. operationId: describe_report_customizations parameters: - name: report in: query required: false schema: anyOf: - type: string maxLength: 80 minLength: 1 - type: 'null' description: >- report page slug from the report catalog; give this or setting_key. title: Report description: report page slug from the report catalog; give this or setting_key. - name: sub_report in: query required: false schema: type: string maxLength: 80 minLength: 1 title: Sub Report description: sub-report slug of that page; standard when omitted. default: standard description: sub-report slug of that page; standard when omitted. - name: setting_key in: query required: false schema: anyOf: - type: string maxLength: 80 minLength: 1 - type: 'null' description: a setting key; give this or report. title: Setting Key description: a setting key; give this or report. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomizationsDescribeResponse' '400': description: >- The request names a value Edgeful cannot use; `detail` says which values are valid. content: application/json: examples: refused: summary: refused value: detail: NQX is not a futures ticker Edgeful knows. '403': description: Valid API key, but the account has no API-enabled subscription. content: application/json: examples: missing_entitlement: summary: missing entitlement value: detail: detail: No active subscription with API access found. code: missing_entitlement '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - BearerAuth: [] x-codeSamples: - lang: curl label: cURL source: |- curl --request GET \ --url 'https://api.edgeful.com/v1/settings/report-customizations?report=' \ --header 'Authorization: Bearer ' - lang: python label: Python source: >- import requests url = "https://api.edgeful.com/v1/settings/report-customizations?report=" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) - lang: javascript label: JavaScript source: >- const url = "https://api.edgeful.com/v1/settings/report-customizations?report="; const options = { method: "GET", headers: { Authorization: "Bearer " }, }; const response = await fetch(url, options); const data = await response.json(); console.log(data); - lang: php label: PHP source: >- "); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer "]); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); curl_close($ch); echo $response; - lang: go label: Go source: |- package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://api.edgeful.com/v1/settings/report-customizations?report=", nil) req.Header.Set("Authorization", "Bearer ") resp, _ := http.DefaultClient.Do(req) defer resp.Body.Close() body, _ := io.ReadAll(resp.Body) fmt.Println(string(body)) } - lang: java label: Java source: >- import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.edgeful.com/v1/settings/report-customizations?report=")) .header("Authorization", "Bearer ") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); - lang: ruby label: Ruby source: >- require "net/http" require "uri" uri = URI("https://api.edgeful.com/v1/settings/report-customizations?report=") request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer " response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http| http.request(request) end puts response.body components: schemas: CustomizationsDescribeResponse: properties: setting_key: anyOf: - type: string - type: 'null' title: Setting Key description: >- the setting key the page stores, or null when the page has no customizations. status: anyOf: - type: string - type: 'null' title: Status description: customized or defaults. slots: items: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object type: array title: Slots description: >- each stored slot with its label, domain, default, current value and dependency. pages: anyOf: - items: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object type: array - type: 'null' title: Pages description: >- every report page the key drives, with the query that applies the saved values. report: anyOf: - type: string - type: 'null' title: Report description: 'pages without customizations: the report page slug.' sub_report: anyOf: - type: string - type: 'null' title: Sub Report description: 'pages without customizations: the sub-report slug.' name: anyOf: - type: string - type: 'null' title: Name description: 'pages without customizations: the display name.' markets: anyOf: - items: type: string type: array - type: 'null' title: Markets description: 'pages without customizations: the markets.' url: anyOf: - type: string - type: 'null' title: Url description: 'pages without customizations: the page in Edgeful.' note: anyOf: - type: string - type: 'null' title: Note description: 'pages without customizations: why there is nothing to describe.' additionalProperties: true type: object required: - slots title: CustomizationsDescribeResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError JsonValue: {} ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Send your Edgeful API key in the Authorization header as `Bearer ` (for example, `Bearer ef_live_`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.