Skip to content

Commit 9dfdec5

Browse files
authored
docs(reference): document the total property in response from /v1/load (#7042)
1 parent e9d189a commit 9dfdec5

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

docs/docs-new/pages/product/apis-integrations/rest-api/query-format.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ A Query has the following properties:
3737
- `limit`: A row limit for your query. The default value is `10000`. The maximum
3838
allowed limit is `50000`. If you'd like to request more rows than the maximum
3939
allowed limit, consider using [pagination][ref-recipe-pagination].
40+
- `total`: If set to `true`, Cube will return the total number of rows for a
41+
query. The default value is `false`.
4042
- `offset`: The number of initial rows to be skipped for your query. The default
4143
value is `0`.
4244
- `order`: An object, where the keys are measures or dimensions to order by and

docs/docs-new/pages/reference/rest-api.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ Response
2424
- `title` - Human readable title from the data model.
2525
- `shortTitle` - Short title for visualization usage (ex. chart overlay)
2626
- `type` - Data type
27+
- `total` - The total number of rows returned for the query. Useful for
28+
paginating results.
2729

2830
Example request:
2931

0 commit comments

Comments
 (0)