Get Chart Card Definition

Retrieves the definition for an existing chart Card.

GET /v1/cards/chart/{cardUrn}

Get Chart Card Definition

cURL

curl --request GET \
  --url https://api.domo.com/v1/cards/chart/{cardUrn} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.domo.com/v1/cards/chart/{cardUrn}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.domo.com/v1/cards/chart/{cardUrn}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.domo.com/v1/cards/chart/{cardUrn}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.domo.com/v1/cards/chart/{cardUrn}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.domo.com/v1/cards/chart/{cardUrn}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.domo.com/v1/cards/chart/{cardUrn}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "calculatedFields": [
    {
      "formula": "<string>",
      "id": "<string>",
      "name": "<string>",
      "saveToDataSet": true
    }
  ],
  "chartBody": {
    "columns": [
      {
        "aggregation": "<string>",
        "alias": "<string>",
        "calendar": true,
        "column": "<string>",
        "format": {
          "alignment": "<string>",
          "commas": true,
          "currency": "<string>",
          "dateFormat": "<string>",
          "format": "<string>",
          "percent": true,
          "percentMultiplied": true,
          "precision": 123,
          "style": "<string>",
          "tableColumn": {
            "aggregation": "<string>",
            "hideSubtotal": true,
            "hideTotal": true,
            "percentOfTotal": true,
            "width": 123
          },
          "type": "<string>"
        },
        "mapping": "<string>"
      }
    ],
    "dateGrain": {
      "column": "<string>",
      "dateTimeElement": "<string>"
    },
    "dateRangeFilter": {
      "filterType": "<string>",
      "field": "<string>",
      "from": 123,
      "not": true,
      "to": 123
    },
    "distinct": true,
    "filters": [
      {
        "column": "<string>",
        "operand": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "fiscal": true,
    "groupBy": [
      {
        "aggregation": "<string>",
        "alias": "<string>",
        "calendar": true,
        "column": "<string>",
        "format": {
          "alignment": "<string>",
          "commas": true,
          "currency": "<string>",
          "dateFormat": "<string>",
          "format": "<string>",
          "percent": true,
          "percentMultiplied": true,
          "precision": 123,
          "style": "<string>",
          "tableColumn": {
            "aggregation": "<string>",
            "hideSubtotal": true,
            "hideTotal": true,
            "percentOfTotal": true,
            "width": 123
          },
          "type": "<string>"
        },
        "mapping": "<string>"
      }
    ],
    "limit": 123,
    "offset": 123,
    "orderBy": [
      {
        "aggregation": "<string>",
        "alias": "<string>",
        "calendar": true,
        "column": "<string>",
        "format": {
          "alignment": "<string>",
          "commas": true,
          "currency": "<string>",
          "dateFormat": "<string>",
          "format": "<string>",
          "percent": true,
          "percentMultiplied": true,
          "precision": 123,
          "style": "<string>",
          "tableColumn": {
            "aggregation": "<string>",
            "hideSubtotal": true,
            "hideTotal": true,
            "percentOfTotal": true,
            "width": 123
          },
          "type": "<string>"
        },
        "mapping": "<string>"
      }
    ],
    "projection": true
  },
  "chartType": "<string>",
  "chartVersion": "<string>",
  "conditionalFormats": [
    {
      "condition": {
        "column": "<string>",
        "operand": "<string>",
        "values": [
          "<string>"
        ]
      },
      "format": {
        "applyToRow": true,
        "color": "<string>",
        "textColor": "<string>",
        "textStyle": "<string>"
      },
      "savedToDataSet": true
    }
  ],
  "dataSetId": "<string>",
  "description": "<string>",
  "goal": 123,
  "metadataOverrides": {},
  "preferredFullHeight": 123,
  "preferredFullWidth": 123,
  "quickFilters": [
    {
      "column": "<string>",
      "name": "<string>",
      "operator": "<string>",
      "type": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "summaryNumber": {
    "columns": [
      {
        "aggregation": "<string>",
        "alias": "<string>",
        "calendar": true,
        "column": "<string>",
        "format": {
          "alignment": "<string>",
          "commas": true,
          "currency": "<string>",
          "dateFormat": "<string>",
          "format": "<string>",
          "percent": true,
          "percentMultiplied": true,
          "precision": 123,
          "style": "<string>",
          "tableColumn": {
            "aggregation": "<string>",
            "hideSubtotal": true,
            "hideTotal": true,
            "percentOfTotal": true,
            "width": 123
          },
          "type": "<string>"
        },
        "mapping": "<string>"
      }
    ],
    "dateGrain": {
      "column": "<string>",
      "dateTimeElement": "<string>"
    },
    "dateRangeFilter": {
      "filterType": "<string>",
      "field": "<string>",
      "from": 123,
      "not": true,
      "to": 123
    },
    "distinct": true,
    "filters": [
      {
        "column": "<string>",
        "operand": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "fiscal": true,
    "groupBy": [
      {
        "aggregation": "<string>",
        "alias": "<string>",
        "calendar": true,
        "column": "<string>",
        "format": {
          "alignment": "<string>",
          "commas": true,
          "currency": "<string>",
          "dateFormat": "<string>",
          "format": "<string>",
          "percent": true,
          "percentMultiplied": true,
          "precision": 123,
          "style": "<string>",
          "tableColumn": {
            "aggregation": "<string>",
            "hideSubtotal": true,
            "hideTotal": true,
            "percentOfTotal": true,
            "width": 123
          },
          "type": "<string>"
        },
        "mapping": "<string>"
      }
    ],
    "limit": 123,
    "offset": 123,
    "orderBy": [
      {
        "aggregation": "<string>",
        "alias": "<string>",
        "calendar": true,
        "column": "<string>",
        "format": {
          "alignment": "<string>",
          "commas": true,
          "currency": "<string>",
          "dateFormat": "<string>",
          "format": "<string>",
          "percent": true,
          "percentMultiplied": true,
          "precision": 123,
          "style": "<string>",
          "tableColumn": {
            "aggregation": "<string>",
            "hideSubtotal": true,
            "hideTotal": true,
            "percentOfTotal": true,
            "width": 123
          },
          "type": "<string>"
        },
        "mapping": "<string>"
      }
    ],
    "projection": true
  },
  "title": "<string>",
  "urn": "<string>"
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

cardUrn · string · required

ID of Card

Response

200

*/*

OK

calculatedFields · object[] | null

Show child attributes

chartBody · object | null

Show child attributes

chartType · string | null

chartVersion · string | null

conditionalFormats · object[] | null

Show child attributes

dataSetId · string | null

description · string | null

goal · number<double> | null

metadataOverrides · object | null

Show child attributes

preferredFullHeight · number<float> | null

preferredFullWidth · number<float> | null

quickFilters · object[] | null

Show child attributes

summaryNumber · object | null

Show child attributes

title · string | null

urn · string | null