Get Report Data

curl --request GET \
  --url https://backend.nebuly.com/api/external/reports/report-data/{report_id} \
  --header 'Authorization: Bearer <token>'

{
  "report_data": {
    "id": "<string>",
    "name": "<string>",
    "charts": [
      {
        "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": [
          {}
        ]
      }
    ]
  }
}

GET

api

external

reports

report-data

{report_id}

Get Report Data

curl --request GET \
  --url https://backend.nebuly.com/api/external/reports/report-data/{report_id} \
  --header 'Authorization: Bearer <token>'

{
  "report_data": {
    "id": "<string>",
    "name": "<string>",
    "charts": [
      {
        "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 full data for a report, including the data for each of its charts.
Use List Reports to find report IDs. You need a public API key (pk-...) to authenticate. See here for more information about API keys.

Path parameters

report_id

string

required

The UUID of the report.

Response

report_data

object

The report and its chart data.

Show properties

string

The unique identifier (UUID) of the report.

name

string

The display name of the report.

charts

object[]

The list of charts belonging to the report. Each element is either an analytics chart or a table chart, identified by the type field.Analytics chart

Show analytics chart properties

type

string

The chart visualization type. Possible values: line_chart, distributed, metric, horizontal_bar, vertical_bar, pie, scatter.

string

The unique identifier (UUID) of the chart.

name

string

The display name of the chart.

variables

string[]

The metric variable slugs visualized by the chart (e.g. ["n_interactions"]).

visualization_type

string | null

The sub-visualization type, if applicable (e.g. "formula" for metric charts).

display_type

string | null

How values are displayed. Either "total" or "percentage".

x_label_values

string[]

The labels for the x-axis. For time series charts these are ISO 8601 datetime strings; for categorical charts these are category names.

breakdown

string | null

The dimension used to split the chart into series, if any (e.g. "topic", "language").

granularity

string | null

The time granularity of the chart data. Possible values: "hour", "day", "week", "month".

time_range

object

The effective time range used to compute this chart’s data.

Show properties

kind

string

The time range kind (see timerange query parameter for possible values).

start

string

ISO 8601 start datetime.

end

string

ISO 8601 end datetime.

data

object[]

The datasets for the chart. Each dataset corresponds to one series (e.g. one breakdown value).

Show properties

label

string

The series label (e.g. the breakdown value or the variable name).

data

object[]

The data points for this series. Each entry corresponds to one x-axis value.

Show properties

number

The index position of this data point, corresponding to the entry at the same index in x_label_values.

number | null

The numeric value for this data point.

user

string | null

The user identifier, present only for user-level breakdowns.

**Table chart

Show table chart properties

type

string

Always "table" for table charts.

string

The unique identifier (UUID) of the chart.

name

string

The display name of the chart.

breakdowns

string[]

The dimension(s) used to group the table rows (e.g. ["topic"], ["topic", "language"]).

columns

string[]

The metric column names present in each row (e.g. ["n_interactions", "n_users"]).

rows

object[]

The table rows. Each row contains the breakdown dimension values and the metric values defined in columns.

List Reports

Get Chart

⌘I

​Path parameters

​Response

Path parameters

Response