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>'

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

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

Show child attributes

preferredFullHeight · number<float> | null

preferredFullWidth · number<float> | null

quickFilters · object[] | null

Show child attributes

summaryNumber · object

Show child attributes

title · string | null

urn · string | null