Skip to main content
Charts reads every chart in a completed parse as data: its type, its axes, and each series as a list of points. It can also export them as Excel, CSV and LAS (well log) files. For a sentence that describes a chart, ask the parse for figure descriptions.

Read a parse’s charts

This example parses a report, then reads its charts and saves them as Excel and CSV files:
For a document with many charts, send async: true and poll the job: see Jobs and results. An expired or deleted parse gets 400 or 410: parse the document again.
Charts must be turned on for your organization. Until it is, POST /charts returns 404, as a route that doesn’t exist, and a pipeline with a Charts step returns 400. To turn it on, contact support.

What Charts reads

Each Figure element on the pages you select that is a chart becomes one entry in charts:
  • In a PDF or image, Charts reads the figure’s pixels and keeps up to data_points points per series, with a confidence from 0 to 1.
  • In an Excel workbook (.xlsx or .xlsm), it reads the workbook’s own chart data: every point, exactly, with confidence: null. Charts in an .xls workbook are skipped.
Charts reads a Word, PowerPoint or HTML document’s charts from the figure images saved with the parse, as for a PDF, so parse it with enhancements.figures.include: true. Without them, Charts skips every figure in the document.
Charts doesn’t see a chart the parse read as a table. The parse’s layout refine pass fixes that.

Choose options

All options in config are optional:

Read the result

GET /charts/{charts_id}/result (client.charts.get_result) returns the charts, in the order of their figures, and the export files:
A series’ data holds [x, y] points, and y is null where it couldn’t be read. An axis that couldn’t be calibrated has scale: "normalized" and values from 0 to 1: treat them as relative, not as the chart’s units. The result’s warnings can include: A FIGURE_SKIPPED or FIGURE_FAILED message starts with the figure’s id, such as Figure-7. If the chart reader can’t be reached at all, the job fails with a 503 and isn’t billed. Run it again later.
If your organization deletes each result on its first read, the export files are deleted with the result. Save them the first time you read it.

Pricing

Charts costs 1 credit per chart returned. Skipped and failed figures and the export files cost nothing (Pricing).

Next steps

Parse

Describe figures, save their images, and fix their layout.

Charts API reference

Every option, field and limit.