Skip to main content
POST
Run Charts

Authorizations

x-api-key
string
header
required

Headers

Pulse-Version
string
default:2

Body

application/json

A completed parse, and how to read its charts.

parse_id
string
required

The parse_id of a completed parse whose result hasn't expired.

Minimum string length: 1
config
ChartsConfig { page_range, data_points, export_formats, 1 more } · object
required

This request's options.

async
boolean
default:false

Set to true to return 202 at once instead of waiting.

Response

The job completed. Read its result at GET /charts/{charts_id}/result.

A completed charts job. Read its result at GET /charts/{charts_id}/result.

charts_id
string
required

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

created_at
string
required

When the job was created.

completed_at
string
required

When the job ended.

expires_at
string

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