ChartQuery

Chart View

GET
/v1/chart/view/{id}

View a previously saved chart as an interactive HTML page. Public, no API key required. Iframe-embeddable.

Path Parameters

id*string

The chart ID returned in the X-Chart-View-URL header when saving a chart. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Query Parameters

share?boolean

Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.

Defaultfalse
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Response Body

Successful response

response?stringapplication/json
Example Request
curl -X GET 'https://api.chartquery.com/v1/chart/view/string'
Example Response
"<!DOCTYPE html><html><!-- interactive chart canvas, responsive, tooltip-enabled --></html>"