Skip to main content
PUT
/
api
/
content
/
v1
/
cards
/
kpi
/
{urn}
/
render
Render KPI Card Chart or Table
curl --request PUT \
  --url https://{instance}.domo.com/api/content/v1/cards/kpi/{urn}/render \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "queryOverrides": {},
  "treatLongsAsStrings": true,
  "cardLoadContext": {}
}
'
{
  "data": [
    "aSDinaTvuI8gbWludGxpZnk="
  ]
}

Authorizations

​
X-DOMO-Developer-Token
string
header
required

Path Parameters

​
urn
string
required

The unique resource name (URN) of the KPI card to be rendered.

Query Parameters

​
locale
string

Specifies the locale in which to render the KPI card.

​
parts
enum<string>[]
required

A list of specific parts of the chart to be rendered. This allows for a customized response that includes only the necessary components.

Available options:
title,
chartType,
queryResult,
data,
image,
imagePDF,
graph,
dynamic,
summary,
summaryImage,
dataSource,
pdp,
annotations,
extendedDateInfo,
table

Body

application/json

The request body must be in JSON format and should adhere to the ChartRequest schema.

The request body must be in JSON format and should adhere to the ChartRequest schema.

​
queryOverrides
object
​
treatLongsAsStrings
boolean
​
cardLoadContext
object

Response

The request was successful, and the KPI card chart or table has been rendered according to the specified parameters. The response will include an array of base64 encoded images.

The request was successful, and the KPI card chart or table has been rendered according to the specified parameters. The response will include an array of base64 encoded images.

​
data
string<byte>[]