Skip to main content
GET
Get Charts Result

Authorizations

x-api-key
string
header
required

Headers

Pulse-Version
string
default:2

Path Parameters

charts_id
string
required

The charts_id that POST /charts returned.

Response

The job's charts and exports.

A completed /charts job's result, read at GET /charts/{charts_id}/result.

charts_id
string
required

The charts job's id, charts-<uuid>.

exports
ChartsExport · object[]
required

The files built in the requested formats, each one in full. Empty when no chart was found.

charts
Chart · object[]
required

Every chart read, one per Figure element on the requested pages, with that element's page and position.

usage
Usage · object
required

The pages and credits this request used.

history
ResultHistory · object
required

Where this result came from.

warnings
Warning · object[]

Issues that may affect this result. Absent when there are none.

expires_at
string

When the result will be deleted. Absent when the result is kept with no expiry.