get_report_tables

To get the list of tables that can be included in reports, use the report/get_report_tables method.

svc=report/get_report_tables&params={}

The request doesn’t require any parameters.

If the request is completed successfully, a response in the following format is returned:

[
	{
		"id":<uint>,		/* table ID */
		"n":"<text>",			/* system table name */
		"l":"<text>",			/* default table name */
		"t":"<text>",			/* table type */
		"ct":"<text>",		/* type of the template in which this table can be used */
		"pt":"<text>",		/* text parameters */
		"gt":"<text>",		/* advanced grouping settings */
		"col":[				/* the array of columns */
			{
				"n":"<text>",		/* system column name */
				"l":"<text>",		/* default column name */
				"sl":"<text>",	/* the list of column headers (if it is a statistics table) */
				"t":"<text>",		/* column type */
				"f":<uint>		/* column flags (see below) */
				"calc_type":<uint>		/* grouping value (if set) */
				"available_calc_types":<uint>		/* grouping values available for the column (if applicable) */
			}
		]
	}
]

The types of report templates are described in the Template types section. Table flags are described on the exec_report page.

Each table is registered separately for every template type, so its n value is unique. The same table has a different name in each template type. For example, the Trips table is unit_trips in an avl_unit template and unit_group_trips in an avl_unit_group template. Use the n value to specify tables in the report/update_report request.

Tables with the same t value are calculated in the same way. To find the counterpart of a table in another template type, look for a table with the same t value and the required ct value.

Not all tables are available for every template type. For example, the Chart (Regular), Fuel traffic, Images, Messages tracing, and Video tables are available for avl_unit templates but have no counterpart for avl_unit_group.

The contents of the unit_location table (Unit latest data) depend on the template type. The table exists for both avl_unit and avl_unit_group, but in an avl_unit template all of its columns are statistics columns with the 0x02 flag. In this case, the table has no rows and adds a block to the report statistics only. As a regular table, Unit latest data is available for avl_unit_group templates only.

The returned list also depends on the account. Tables are filtered by the services available to the current user, so different users can receive different lists of tables.

The f parameter of a column can have the following values:

The f value is a bitmask, so a column can have several flags at once. For example, 0x01 + 0x02 = 0x03 means that the column is shown both as a table column and as a statistics column.

The columns with the 0x100 and 0x200 flags belong to the tables that supply data for the chart (for example, unit_events or unit_stays), not to the chart table itself. They define what is drawn on the chart. For details, see Markers and Background.

The pt parameter lists the text parameters and options available for the table. It can have the following values: