Charts

Get a chart by fully qualified name

Get a chart by fullyQualifiedName.

get/v1/charts/name/{fqn}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/charts/name/{fqn}
  • Auth: HTTP bearer

Path parameters

fqnstring required

Fully qualified name of the chart

Query parameters

fieldsstring
Example:owners,followers,tags,domains,dataProducts,sourceHash,dashboards,extension

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

includeRelationsstring
Example:owners:non-deleted,followers:all

Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value.

Response

The chart

idstring uuid required
namestring required
displayNamestring
fullyQualifiedNamestring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
chartType'Line' | 'Table' | 'Bar' | 'Area' | 'Pie' | 'Histogram' | 'Scatter' | 'Text' | 'BoxPlot' | 'SanKey' | 'Gauge' | 'Map' | 'Graph' | 'Heatmap' | 'Timeline' | 'Other'
sourceUrlstring
hrefstring uri
serviceType'Superset' | 'Looker' | 'Tableau' | 'Redash' | 'Metabase' | 'PowerBI' | 'PowerBIReportServer' | 'Mode' | 'CustomDashboard' | 'DomoDashboard' | 'QuickSight' | 'QlikSense' | 'Lightdash' | 'MicroStrategy' | 'QlikCloud' | 'Sigma' | 'ThoughtSpot' | 'Grafana' | 'Hex' | 'Ssrs' | 'SapS4Hana' | 'Omni'
deletedboolean
sourceHashstring
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'

Changes

No recorded changes to this operation across all 1 revision of this API.