Get row record pivot data

POST

/v3/app/worksheets/{worksheet_id}/rows/pivot

Get worksheet record pivot summary data for data analysis and statistics, consistent with the pivot table feature used in statistics.

Request

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "pageSize": 100,
    "pageIndex": 1,
    "viewId": "string",
    "columns": [
        {}
    ],
    "rows": [
        {
            "field": "string",
            "displayName": "string",
            "granularity": 0,
            "includeEmpty": false
        }
    ],
    "values": [
        {
            "field": "string",
            "displayName": "string",
            "aggregation": "COUNT",
            "includeEmpty": false
        }
    ],
    "filter": {
        "type": "group",
        "logic": "AND",
        "field": "string",
        "operator": "string",
        "value": null,
        "children": [
            {
                "type": "group",
                "logic": "AND",
                "field": "string",
                "operator": "string",
                "value": null,
                "children": {}
            }
        ]
    },
    "sorts": [
        {
            "field": "string",
            "isAsc": true
        }
    ],
    "includeSummary": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://www.nocoly.com/v3/app/worksheets//rows/pivot' \
--header 'HAP-Appkey;' \
--header 'HAP-Sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pageSize": 100,
    "pageIndex": 1,
    "viewId": "string",
    "columns": [
        {}
    ],
    "rows": [
        {
            "field": "string",
            "displayName": "string",
            "granularity": 0,
            "includeEmpty": false
        }
    ],
    "values": [
        {
            "field": "string",
            "displayName": "string",
            "aggregation": "COUNT",
            "includeEmpty": false
        }
    ],
    "filter": {
        "type": "group",
        "logic": "AND",
        "field": "string",
        "operator": "string",
        "value": null,
        "children": [
            {
                "type": "group",
                "logic": "AND",
                "field": "string",
                "operator": "string",
                "value": null,
                "children": {}
            }
        ]
    },
    "sorts": [
        {
            "field": "string",
            "isAsc": true
        }
    ],
    "includeSummary": false
}'

Responses

🟢200OK

application/json

Successfully retrieved pivot table data

Body

Example

{
    "success": true,
    "error_code": 0,
    "error_msg": "string",
    "data": {
        "meta": {
            "columns": [
                {}
            ],
            "rows": [
                {}
            ],
            "values": [
                {}
            ]
        },
        "pivot": [
            {
                "columns": {
                    "property1": "string",
                    "property2": "string"
                },
                "rows": {
                    "property1": "string",
                    "property2": "string"
                },
                "values": {
                    "property1": 0,
                    "property2": 0
                }
            }
        ],
        "summary": {
            "property1": 0,
            "property2": 0
        },
        "totalPages": 0,
        "currentPage": 0
    }
}

Modified at 2026-03-30 07:15:12

Get row record logs

Get related records