> ## 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. # custom report run > read one run of a saved custom report by its run_id: status running and poll_after_seconds while it computes, then its result with every row. never starts a run. works with writes off. ## OpenAPI ````yaml /openapi-public.json get /v1/custom-reports/{definition_id}/runs/{run_id} 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/{definition_id}/runs/{run_id}: get: tags: - custom reports summary: custom report run description: >- read one run of a saved custom report by its run_id: status running and poll_after_seconds while it computes, then its result with every row. never starts a run. works with writes off. operationId: get_custom_report_run parameters: - name: definition_id in: path required: true schema: type: string format: uuid description: the saved custom report's id, from the list. title: Definition Id description: the saved custom report's id, from the list. - name: run_id in: path required: true schema: type: string format: uuid description: the run's id, from run custom report or the latest result. title: Run Id description: the run's id, from run custom report or the latest result. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomReportRunResult' '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 '404': description: No saved custom report with that id belongs to this account. content: application/json: examples: not_found: summary: not found value: detail: Custom report not found. '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//runs/' \ --header 'Authorization: Bearer ' - lang: python label: Python source: >- import requests url = "https://api.edgeful.com/v1/custom-reports//runs/" 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//runs/"; 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: >- /runs/"); 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/custom-reports//runs/", 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//runs/")) .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//runs/") 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: CustomReportRunResult: properties: status: type: string title: Status description: >- running, the run's outcome such as succeeded or failed, or no_result when the report has no successful run. definition_id: type: string title: Definition Id description: saved custom report id. run_id: anyOf: - type: string - type: 'null' title: Run Id description: the run that produced the result. message: anyOf: - type: string - type: 'null' title: Message description: a note about the run. effective_controls: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: the inputs the run actually used. data_through: anyOf: - type: string - type: 'null' title: Data Through description: the last date the data covers. computed_at: anyOf: - type: string - type: 'null' title: Computed At description: when the run finished. retryable: anyOf: - type: boolean - type: 'null' title: Retryable description: whether a failed run may be retried. retry_after_seconds: anyOf: - type: integer - type: 'null' title: Retry After Seconds description: seconds to wait before retrying. poll_after_seconds: anyOf: - type: number - type: 'null' title: Poll After Seconds description: 'while running: seconds to wait before reading the run again.' route_to_refine: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: where to refine the report. summary: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: the result's summary values. detailed_data: anyOf: - items: $ref: '#/components/schemas/JsonValue' type: array - type: 'null' title: Detailed Data description: the result's rows, every one the run stored. total_rows: anyOf: - type: integer - type: 'null' title: Total Rows description: rows in the result. truncated: anyOf: - type: boolean - type: 'null' title: Truncated description: true when the response does not carry every row. column_units: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: units per column. row_label: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: what a row represents. row_grain: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: the row grain. presentation: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: presentation hints. url: anyOf: - type: string - type: 'null' title: Url description: the report in Edgeful. additionalProperties: true type: object required: - status - definition_id title: CustomReportRunResult 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.