Infographics
Generated data graphics: an HTML source and the image rendered from it.
List infographics
Returns the newest revision of each infographic, with how many revisions it has. Earlier ones are read through the versions endpoint.
query Parameters
file_namelimitoffsetsearchsort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List infographics › Responses
Success
file_idfile_namefile_typefile_sizefile_createdfile_updatedfile_added_byfile_repofile_hashfile_metadatafile_replicasfile_provider_idfile_bucketfile_folderfile_prefversion_countDelete an infographic
Removes the image and the HTML it was rendered from — deleting only the picture would leave the source holding storage with nothing pointing at it. Pass versions=all to remove every revision.
path Parameters
idquery Parameters
versionsHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete an infographic › Responses
Success
Rename an infographic
Renames the source and the image together, so the card and both downloads agree. Extensions are kept.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Rename an infographic › Responses
Success
Get who has access
Returns who may read and edit this infographic. An empty result means unrestricted.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get who has access › Responses
Success
Set who has access
Applies to the HTML source as well as the image. Sharing a picture whose source stayed private would hand someone a card they cannot open, edit or export.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Set who has access › Responses
Success
Download the HTML source
Returns the HTML the image was rendered from — the editable source, not the picture.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Download the HTML source › Responses
Success
Download the image
Returns the rendered image. For a fresh render after a data refresh, snapshot it first.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Download the image › Responses
Success
Refresh the data
Rebuilds the infographic from its stored brief, size and style and adds the result as the newest revision. Only the figures change.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Refresh the data › Responses
Success
Set the refresh schedule
Re-reads the data source on a cadence and posts a new revision each time. Only an infographic with a stored brief can be scheduled — without one there is nothing to regenerate from.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Set the refresh schedule › Request Body
enabledcadenceSet the refresh schedule › Responses
Success
Render a PNG
Renders the current HTML and files the image as the newest revision, so the list shows what the editor last saved. Used after an edit uploads new HTML.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Render a PNG › Responses
Success
Convert to a design
Turns a rendered page into something editable: charts and background become an image plate, and each piece of copy becomes a text layer at its measured position, font and color.
Requires the module-design license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Convert to a design › Responses
Success
List versions
Returns the earlier revisions of this infographic, newest first.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List versions › Responses
Success
