XExentral
Documentation

List documentations

Returns a list of table documentation for each queryable table in the report builder

get/api/v1/analytics/documentation

Request

Response

Documentation response

Example response

{
  "data": [
    {
      "label": "users",
      "shortDescription": "Users table",
      "longDescription": "This table contains information about users",
      "owners": [
        "john.doe@xentral.com"
      ],
      "columns": [
        {
          "name": "id",
          "description": "Unique identifier",
          "type": "integer",
          "source": "users.id"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.