Get Chart
curl --request GET \
--url https://backend.nebuly.com/api/external/charts/{chart_id} \
--header 'Authorization: Bearer <token>'{
"chart": {
"type": "<string>",
"id": "<string>",
"name": "<string>",
"variables": [
"<string>"
],
"visualization_type": {},
"display_type": {},
"x_label_values": [
"<string>"
],
"breakdown": {},
"granularity": {},
"time_range": {
"kind": "<string>",
"start": "<string>",
"end": "<string>"
},
"data": [
{
"label": "<string>",
"data": [
{
"x": 123,
"y": {},
"user": {}
}
]
}
],
"breakdowns": [
"<string>"
],
"columns": [
"<string>"
],
"rows": [
{}
]
}
}Reports API
Get Chart
GET
/
api
/
external
/
charts
/
{chart_id}
Get Chart
curl --request GET \
--url https://backend.nebuly.com/api/external/charts/{chart_id} \
--header 'Authorization: Bearer <token>'{
"chart": {
"type": "<string>",
"id": "<string>",
"name": "<string>",
"variables": [
"<string>"
],
"visualization_type": {},
"display_type": {},
"x_label_values": [
"<string>"
],
"breakdown": {},
"granularity": {},
"time_range": {
"kind": "<string>",
"start": "<string>",
"end": "<string>"
},
"data": [
{
"label": "<string>",
"data": [
{
"x": 123,
"y": {},
"user": {}
}
]
}
],
"breakdowns": [
"<string>"
],
"columns": [
"<string>"
],
"rows": [
{}
]
}
}Returns the data for a single chart by ID.
Chart IDs are returned by the Get Report Data endpoint inside each report’s
Chart IDs are returned by the Get Report Data endpoint inside each report’s
charts array.
You need a public API key (pk-...) to authenticate. See here for more information about API keys.
Path parameters
The UUID of the chart.
Response
The chart data. The shape depends on the chart type, identified by the
Table chart
type field.Analytics chartShow analytics chart properties
Show analytics chart properties
The chart visualization type. Possible values:
line_chart, distributed,
metric, horizontal_bar, vertical_bar, pie, scatter.The unique identifier (UUID) of the chart.
The display name of the chart.
The metric variable slugs visualized by the chart (e.g.
["n_interactions"]).The sub-visualization type, if applicable (e.g.
"formula" for metric
charts).How values are displayed. Either
"total" or "percentage".The labels for the x-axis. For time series charts these are ISO 8601
datetime strings; for categorical charts these are category names.
The dimension used to split the chart into series, if any (e.g.
"topic",
"language").The time granularity of the chart data. Possible values:
"hour", "day",
"week", "month".The datasets for the chart. Each dataset corresponds to one series (e.g. one
breakdown value).
Show properties
Show properties
The series label (e.g. the breakdown value or the variable name).
The data points for this series. Each entry corresponds to one x-axis
value.
Show table chart properties
Show table chart properties
Always
"table" for table charts.The unique identifier (UUID) of the chart.
The display name of the chart.
The dimension(s) used to group the table rows (e.g.
["topic"], ["topic", "language"]).The metric column names present in each row (e.g.
["n_interactions", "n_users"]).The table rows. Each row contains the breakdown dimension values and the metric values defined in
columns.⌘I