> ## 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. # list custom reports > list your saved custom reports and their methodology, a page at a time. if has_more is true, pass next_offset as offset for the next page; byte truncation can shorten a page. works with writes off. ## OpenAPI ````yaml /openapi-public.json get /v1/custom-reports 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/custom-reports: get: tags: - custom reports summary: list custom reports description: >- list your saved custom reports and their methodology, a page at a time. if has_more is true, pass next_offset as offset for the next page; byte truncation can shorten a page. works with writes off. operationId: list_custom_reports parameters: - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 description: page size. default: 20 title: Limit description: page size. - name: offset in: query required: false schema: type: integer maximum: 1000000 minimum: 0 description: number of reports to skip; use next_offset from the previous page. default: 0 title: Offset description: number of reports to skip; use next_offset from the previous page. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomReportsListResponse' '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/custom-reports' \ --header 'Authorization: Bearer ' - lang: python label: Python source: |- import requests url = "https://api.edgeful.com/v1/custom-reports" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) - lang: javascript label: JavaScript source: |- const url = "https://api.edgeful.com/v1/custom-reports"; 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_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/custom-reports", 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/custom-reports")) .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/custom-reports") 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: CustomReportsListResponse: properties: definitions: items: $ref: '#/components/schemas/CustomReportDefinition' type: array title: Definitions description: this page of saved reports. total: type: integer title: Total description: number of saved reports. has_more: type: boolean title: Has More description: whether another page follows. next_offset: type: integer title: Next Offset description: offset of the next page. truncated: anyOf: - type: boolean - type: 'null' title: Truncated description: >- true when the page was cut to stay under about 46 KB; next_offset continues after the last report returned. additionalProperties: true type: object required: - definitions - total - has_more - next_offset title: CustomReportsListResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CustomReportDefinition: properties: definition_id: type: string title: Definition Id description: saved custom report id. name: type: string title: Name description: report name. methodology: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: the methodology the builder recorded. assumptions: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: the assumptions the builder recorded. origin: anyOf: - type: string - type: 'null' title: Origin description: api for a report saved through the API, else app. additionalProperties: true type: object required: - definition_id - name title: CustomReportDefinition 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 JsonValue: {} 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.