Change a chart’s type, theme, title or language

Redraws from the same data: free, no new search. type must be one of compatible_types.

patch/v1/charts/{id}

Request

  • Base URL: https://api.typesearch.ai
  • URL: https://api.typesearch.ai/v1/charts/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

type'line' | 'area' | 'bar' | 'bar_horizontal' | 'stacked_bar' | 'pie' | 'donut' | 'scatter' | 'funnel' | 'timeline' | 'kpi' | 'table'
theme'light' | 'dark' | 'editorial' | 'electric'
titlestring
subtitlestring
locale'en' | 'es'

Response

The updated chart.

idstring nullable required

chart_…; null with store: false or plan_only.

object'chart' required
type'line' | 'area' | 'bar' | 'bar_horizontal' | 'stacked_bar' | 'pie' | 'donut' | 'scatter' | 'funnel' | 'timeline' | 'kpi' | 'table' nullable required
theme'light' | 'dark' | 'editorial' | 'electric' required
locale'en' | 'es' required
compatible_typesstring[] required

The chart types this data supports.

rung'exact' | 'partial' | 'related' | 'coverage' | 'stories' nullable required

How close the chart is to what was asked. exact: the data itself, complete and verified; partial: a verified part (the podium); related: another view of the same question (the most mentioned names); coverage: the coverage or the timeline; stories: the top stories. Null for your own data.

improvingboolean required

Still looking for what was asked: the stored chart (embed, image) updates itself if it arrives. Poll GET /v1/charts/{id} or use stream: true.

embed_urlstring nullable required

An iframe that adapts to its width, with tooltips. Add ?theme= to change the theme.

image_urlstring nullable required

PNG at twice the resolution, for chat, email or slides.

svg_urlstring nullable required
svgstring nullable required

The SVG, with include_svg or store: false.

created_atstring nullable required
expires_atstring nullable required
cachedboolean required

The same request in the last 10 minutes: the same chart, not billed.

Changes

No recorded changes to this operation across all 1 revision of this API.