Evaluations

The app-evaluator service is responsible for running in-cluster performance and scalability tests/evaluations of apps

Endpoints

Skip to section
GET/v1/evaluations
POST/v1/evaluations
GET/v1/evaluations/{id}
GET/v1/evaluations/{id}/download

Retrieve a list of all historic evaluations for app item id or an app GUID

builddeprecated

Find all evaluations for an app item id or GUID. appId or itemId has to be set in a query parameter. NOTE: It is preferred to use the app item id as this lookup is more performant. Supports paging via next, prev which are sent in the response body

Facts GET /v1/evaluations

Rate limit
Tier 1 (1000 requests per minute)

Query Parameters GET /v1/evaluations

all
optional
boolean

Get the full data of the evaluation

appId
optional
string

The app guid.

fileMode
optional
boolean

Add file transfer headers to response

format
optional
string

Specify output format, currently supported are 'json' and 'xml'

itemId
optional
string

The app item id.

limit
optional, default=20, minimum=1, maximum=100
integer<int32>

Number of results to return per page.

next
optional
string

The app evaluation id to get next page from

prev
optional
string

The app evaluation id to get previous page from

Responses GET /v1/evaluations

200
optional, application/json

Evaluation(s) retrieved successfully.

404
optional, application/json

Not Found.

500
optional, application/json

Internal server error.

GET/v1/evaluations

curl "https://your-tenant.us.qlikcloud.com/api/v1/evaluations" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/evaluations

{
  "links": {
    "next": "/api/v1/evaluations/appId=a84c22cf-31e5-41fe-9e8f-544b85513484&prev=5f5201908b3fc5fc132dbd35"
  },
  "evaluations": [
    {
      "id": "5ecb5e65028d1f0001a98071",
      "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
      "ended": "2022-02-09T06:58:40.575Z",
      "events": [
        {
          "details": "An object failed",
          "sheetId": "gregFG",
          "objectId": "adfRFr",
          "severity": "warning",
          "errorCode": "ERR-GOPHERCISER",
          "objectType": "linechart",
          "sheetTitle": "mysheet",
          "objectTitle": "profit",
          "objectVisualization": "linechart"
        }
      ],
      "result": {
        "sheets": [
          {
            "sheet": {
              "id": "fjETFn",
              "title": "my chart",
              "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
              "objectType": 1,
              "responseTimeSeconds1": 12.3,
              "responseTimeSeconds2": 12.3
            },
            "objectCount": 1,
            "sheetObjects": [
              {
                "id": "fjETFn",
                "title": "my chart",
                "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
                "objectType": 1,
                "responseTimeSeconds1": 12.3,
                "responseTimeSeconds2": 12.3
              }
            ]
          }
        ],
        "objHeavy": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "cpuSeconds1": 12.3,
            "cpuSeconds2": 12.3,
            "cpuQuotient1": 12.3,
            "cpuQuotient2": 12.3
          }
        ],
        "rowCount": 20000,
        "objNoCache": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "responseTimeSeconds1": 12.3,
            "responseTimeSeconds2": 12.3
          }
        ],
        "sheetCount": 5,
        "fileSizeMiB": 12.3,
        "objectCount": 33,
        "maxMemoryMiB": 12.3,
        "objSlowCached": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "schema": {
              "id": "fjETFn",
              "title": "my chart",
              "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
              "objectType": 1
            },
            "cpuQuotients1": [],
            "cpuQuotients2": [],
            "responseTimeSeconds1": 12.3,
            "responseTimeSeconds2": 12.3
          }
        ],
        "documentSizeMiB": 12.3,
        "objSlowUncached": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "responseTimeSeconds1": 12.3,
            "responseTimeSeconds2": 12.3
          }
        ],
        "dataModelSizeMiB": 654.6,
        "hasSectionAccess": true,
        "topFieldsByBytes": [
          {
            "name": "a",
            "byte_size": 1234,
            "is_system": true,
            "cardinal": 1112,
            "total_count": 1234
          }
        ],
        "topTablesByBytes": [
          {
            "name": "a",
            "byte_size": 1234,
            "is_system": true,
            "no_of_rows": 1234
          }
        ],
        "objSingleThreaded": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "cpuSeconds1": 12.3,
            "cpuSeconds2": 12.3,
            "cpuQuotient1": 12.3,
            "cpuQuotient2": 12.3
          }
        ],
        "appOpenTimeSeconds": 12.3
      },
      "status": "finished",
      "userId": "CGMCdm9v4kuTdfimNMacdnsaFI9njcmB",
      "appName": "my app",
      "details": {
        "errors": [],
        "openApp": {
          "cpuSeconds": [],
          "cpuQuotients": [],
          "responseTimeSeconds": 234.3
        },
        "warnings": [],
        "dedicated": true,
        "fileSizeMiB": 12.3,
        "objectMetrics": {},
        "openAppCached": {
          "cpuSeconds": [],
          "cpuQuotients": [],
          "responseTimeSeconds": 234.3
        },
        "engineHasCache": true,
        "concurrentReload": true,
        "minMemoryFreeMiB": 12.3,
        "maxMemoryUsageMiB": 12.3,
        "physicalMemoryMiB": 12.3,
        "maxMemoryCachedMiB": 12.3,
        "maxMemoryNotFreeMiB": 12.3,
        "maxMemoryWorkingMiB": 12.3
      },
      "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "spaceId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "started": "2022-02-09T06:58:40.575Z",
      "version": 1,
      "metadata": {
        "reloadmeta": {
          "cpuspent": "123983",
          "peakmemorybytes": 112
        },
        "amountofrows": 1423423234,
        "amountoffields": 12,
        "amountoftables": 7,
        "staticbytesize": 1444234,
        "hassectionaccess": true,
        "amountoffieldvalues": 144423433,
        "amountofcardinalfieldvalues": 14442
      },
      "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "timestamp": "2022-02-09T06:58:40.575Z",
      "sheetTitle": "my sheet"
    }
  ]
}

Queue an app evaluation

builddeprecated

Queue an app evaluation by its item id or app guid. NOTE: It is preferred to use the app item id as this lookup is more performant.

Facts POST /v1/evaluations

Rate limit
Tier 2 (100 requests per minute)

Request Body POST /v1/evaluations

optional, application/json

The parameters of the evaluation

Responses POST /v1/evaluations

201
optional, application/json

App evaluation queued.

400
optional, application/json

Bad request, incorrect body.

403
optional, application/json

User lacks permissions to evaluate app.

500
optional, application/json

Internal server error.

POST/v1/evaluations

curl "https://your-tenant.us.qlikcloud.com/api/v1/evaluations" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"appId":"7c2ce11d-4d10-4414-a9b0-620e57298038","itemId":"5e6f8cc63d33cc00018db30b"}'

Request POST /v1/evaluations

{
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "itemId": "5e6f8cc63d33cc00018db30b"
}

Response POST /v1/evaluations

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "ended": "2022-02-09T06:58:40.575Z",
  "events": [
    {
      "details": "An object failed",
      "sheetId": "gregFG",
      "objectId": "adfRFr",
      "severity": "warning",
      "errorCode": "ERR-GOPHERCISER",
      "objectType": "linechart",
      "sheetTitle": "mysheet",
      "objectTitle": "profit",
      "objectVisualization": "linechart"
    }
  ],
  "result": {
    "sheets": [
      {
        "sheet": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1,
          "responseTimeSeconds1": 12.3,
          "responseTimeSeconds2": 12.3
        },
        "objectCount": 1,
        "sheetObjects": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "responseTimeSeconds1": 12.3,
            "responseTimeSeconds2": 12.3
          }
        ]
      }
    ],
    "objHeavy": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": 12.3,
        "cpuSeconds2": 12.3,
        "cpuQuotient1": 12.3,
        "cpuQuotient2": 12.3
      }
    ],
    "rowCount": 20000,
    "objNoCache": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds1": 12.3,
        "responseTimeSeconds2": 12.3
      }
    ],
    "sheetCount": 5,
    "fileSizeMiB": 12.3,
    "objectCount": 33,
    "maxMemoryMiB": 12.3,
    "objSlowCached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "schema": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1
        },
        "cpuQuotients1": [],
        "cpuQuotients2": [],
        "responseTimeSeconds1": 12.3,
        "responseTimeSeconds2": 12.3
      }
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds1": 12.3,
        "responseTimeSeconds2": 12.3
      }
    ],
    "dataModelSizeMiB": 654.6,
    "hasSectionAccess": true,
    "topFieldsByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true,
        "cardinal": 1112,
        "total_count": 1234
      }
    ],
    "topTablesByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true,
        "no_of_rows": 1234
      }
    ],
    "objSingleThreaded": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": 12.3,
        "cpuSeconds2": 12.3,
        "cpuQuotient1": 12.3,
        "cpuQuotient2": 12.3
      }
    ],
    "appOpenTimeSeconds": 12.3
  },
  "status": "finished",
  "userId": "CGMCdm9v4kuTdfimNMacdnsaFI9njcmB",
  "appName": "my app",
  "details": {
    "errors": [],
    "openApp": {
      "cpuSeconds": [],
      "cpuQuotients": [],
      "responseTimeSeconds": 234.3
    },
    "warnings": [],
    "dedicated": true,
    "fileSizeMiB": 12.3,
    "objectMetrics": {},
    "openAppCached": {
      "cpuSeconds": [],
      "cpuQuotients": [],
      "responseTimeSeconds": 234.3
    },
    "engineHasCache": true,
    "concurrentReload": true,
    "minMemoryFreeMiB": 12.3,
    "maxMemoryUsageMiB": 12.3,
    "physicalMemoryMiB": 12.3,
    "maxMemoryCachedMiB": 12.3,
    "maxMemoryNotFreeMiB": 12.3,
    "maxMemoryWorkingMiB": 12.3
  },
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "spaceId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "started": "2022-02-09T06:58:40.575Z",
  "version": 1,
  "metadata": {
    "reloadmeta": {
      "cpuspent": "123983",
      "peakmemorybytes": 112
    },
    "amountofrows": 1423423234,
    "amountoffields": 12,
    "amountoftables": 7,
    "staticbytesize": 1444234,
    "hassectionaccess": true,
    "amountoffieldvalues": 144423433,
    "amountofcardinalfieldvalues": 14442
  },
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "timestamp": "2022-02-09T06:58:40.575Z",
  "sheetTitle": "my sheet"
}

Retrieve a specific evaluation

builddeprecated

Find an evaluation by a specific id.

Facts GET /v1/evaluations/{id}

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/evaluations/{id}

id
string

Id of the desired evaluation.

Query Parameters GET /v1/evaluations/{id}

all
optional
boolean

Get the full data of the evaluation

format
optional
string

Specify output format, currently supported are 'json' and 'xml'

Responses GET /v1/evaluations/{id}

200
optional, application/json

Evaluation(s) retrieved successfully.

404
optional, application/json

Not Found.

500
optional, application/json

Internal server error.

GET/v1/evaluations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/evaluations/{id}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/evaluations/{id}

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "ended": "2022-02-09T06:58:40.575Z",
  "events": [
    {
      "details": "An object failed",
      "sheetId": "gregFG",
      "objectId": "adfRFr",
      "severity": "warning",
      "errorCode": "ERR-GOPHERCISER",
      "objectType": "linechart",
      "sheetTitle": "mysheet",
      "objectTitle": "profit",
      "objectVisualization": "linechart"
    }
  ],
  "result": {
    "sheets": [
      {
        "sheet": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1,
          "responseTimeSeconds1": 12.3,
          "responseTimeSeconds2": 12.3
        },
        "objectCount": 1,
        "sheetObjects": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "responseTimeSeconds1": 12.3,
            "responseTimeSeconds2": 12.3
          }
        ]
      }
    ],
    "objHeavy": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": 12.3,
        "cpuSeconds2": 12.3,
        "cpuQuotient1": 12.3,
        "cpuQuotient2": 12.3
      }
    ],
    "rowCount": 20000,
    "objNoCache": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds1": 12.3,
        "responseTimeSeconds2": 12.3
      }
    ],
    "sheetCount": 5,
    "fileSizeMiB": 12.3,
    "objectCount": 33,
    "maxMemoryMiB": 12.3,
    "objSlowCached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "schema": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1
        },
        "cpuQuotients1": [],
        "cpuQuotients2": [],
        "responseTimeSeconds1": 12.3,
        "responseTimeSeconds2": 12.3
      }
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds1": 12.3,
        "responseTimeSeconds2": 12.3
      }
    ],
    "dataModelSizeMiB": 654.6,
    "hasSectionAccess": true,
    "topFieldsByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true,
        "cardinal": 1112,
        "total_count": 1234
      }
    ],
    "topTablesByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true,
        "no_of_rows": 1234
      }
    ],
    "objSingleThreaded": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": 12.3,
        "cpuSeconds2": 12.3,
        "cpuQuotient1": 12.3,
        "cpuQuotient2": 12.3
      }
    ],
    "appOpenTimeSeconds": 12.3
  },
  "status": "finished",
  "userId": "CGMCdm9v4kuTdfimNMacdnsaFI9njcmB",
  "appName": "my app",
  "details": {
    "errors": [],
    "openApp": {
      "cpuSeconds": [],
      "cpuQuotients": [],
      "responseTimeSeconds": 234.3
    },
    "warnings": [],
    "dedicated": true,
    "fileSizeMiB": 12.3,
    "objectMetrics": {},
    "openAppCached": {
      "cpuSeconds": [],
      "cpuQuotients": [],
      "responseTimeSeconds": 234.3
    },
    "engineHasCache": true,
    "concurrentReload": true,
    "minMemoryFreeMiB": 12.3,
    "maxMemoryUsageMiB": 12.3,
    "physicalMemoryMiB": 12.3,
    "maxMemoryCachedMiB": 12.3,
    "maxMemoryNotFreeMiB": 12.3,
    "maxMemoryWorkingMiB": 12.3
  },
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "spaceId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "started": "2022-02-09T06:58:40.575Z",
  "version": 1,
  "metadata": {
    "reloadmeta": {
      "cpuspent": "123983",
      "peakmemorybytes": 112
    },
    "amountofrows": 1423423234,
    "amountoffields": 12,
    "amountoftables": 7,
    "staticbytesize": 1444234,
    "hassectionaccess": true,
    "amountoffieldvalues": 144423433,
    "amountofcardinalfieldvalues": 14442
  },
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "timestamp": "2022-02-09T06:58:40.575Z",
  "sheetTitle": "my sheet"
}

Download a detailed XML log of a specific evaluation

builddeprecated

Find and download an evaluation log by a specific evaluation id.

Facts GET /v1/evaluations/{id}/download

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/evaluations/{id}/download

id
string

Id of the desired evaluation.

Responses GET /v1/evaluations/{id}/download

200
optional, application/xml

Evaluation(s) retrieved successfully.

404
optional, application/json

Not Found.

500
optional, application/json

Internal server error.

GET/v1/evaluations/{id}/download

curl "https://your-tenant.us.qlikcloud.com/api/v1/evaluations/{id}/download" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/evaluations/{id}/download

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "ended": "2022-02-09T06:58:40.575Z",
  "events": [
    {
      "details": "An object failed",
      "sheetId": "gregFG",
      "objectId": "adfRFr",
      "severity": "warning",
      "errorCode": "ERR-GOPHERCISER",
      "objectType": "linechart",
      "sheetTitle": "mysheet",
      "objectTitle": "profit",
      "objectVisualization": "linechart"
    }
  ],
  "result": {
    "sheets": [
      {
        "sheet": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1,
          "responseTimeSeconds1": 12.3,
          "responseTimeSeconds2": 12.3
        },
        "objectCount": 1,
        "sheetObjects": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "responseTimeSeconds1": 12.3,
            "responseTimeSeconds2": 12.3
          }
        ]
      }
    ],
    "objHeavy": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": 12.3,
        "cpuSeconds2": 12.3,
        "cpuQuotient1": 12.3,
        "cpuQuotient2": 12.3
      }
    ],
    "rowCount": 20000,
    "objNoCache": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds1": 12.3,
        "responseTimeSeconds2": 12.3
      }
    ],
    "sheetCount": 5,
    "fileSizeMiB": 12.3,
    "objectCount": 33,
    "maxMemoryMiB": 12.3,
    "objSlowCached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "schema": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1
        },
        "cpuQuotients1": [],
        "cpuQuotients2": [],
        "responseTimeSeconds1": 12.3,
        "responseTimeSeconds2": 12.3
      }
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds1": 12.3,
        "responseTimeSeconds2": 12.3
      }
    ],
    "dataModelSizeMiB": 654.6,
    "hasSectionAccess": true,
    "topFieldsByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true,
        "cardinal": 1112,
        "total_count": 1234
      }
    ],
    "topTablesByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true,
        "no_of_rows": 1234
      }
    ],
    "objSingleThreaded": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": 12.3,
        "cpuSeconds2": 12.3,
        "cpuQuotient1": 12.3,
        "cpuQuotient2": 12.3
      }
    ],
    "appOpenTimeSeconds": 12.3
  },
  "status": "finished",
  "userId": "CGMCdm9v4kuTdfimNMacdnsaFI9njcmB",
  "appName": "my app",
  "details": {
    "errors": [],
    "openApp": {
      "cpuSeconds": [],
      "cpuQuotients": [],
      "responseTimeSeconds": 234.3
    },
    "warnings": [],
    "dedicated": true,
    "fileSizeMiB": 12.3,
    "objectMetrics": {},
    "openAppCached": {
      "cpuSeconds": [],
      "cpuQuotients": [],
      "responseTimeSeconds": 234.3
    },
    "engineHasCache": true,
    "concurrentReload": true,
    "minMemoryFreeMiB": 12.3,
    "maxMemoryUsageMiB": 12.3,
    "physicalMemoryMiB": 12.3,
    "maxMemoryCachedMiB": 12.3,
    "maxMemoryNotFreeMiB": 12.3,
    "maxMemoryWorkingMiB": 12.3
  },
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "spaceId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "started": "2022-02-09T06:58:40.575Z",
  "version": 1,
  "metadata": {
    "reloadmeta": {
      "cpuspent": "123983",
      "peakmemorybytes": 112
    },
    "amountofrows": 1423423234,
    "amountoffields": 12,
    "amountoftables": 7,
    "staticbytesize": 1444234,
    "hassectionaccess": true,
    "amountoffieldvalues": 144423433,
    "amountofcardinalfieldvalues": 14442
  },
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "timestamp": "2022-02-09T06:58:40.575Z",
  "sheetTitle": "my sheet"
}

Error

object

Properties

errors
optional

No description

evaluation

object

Properties

id
optional
string<string>

No description

appId
optional
string<string>

No description

ended
optional
string<date-time>

No description

events
optional

No description

result
optional

No description

status
optional
string<string>

No description

userId
optional
string<string>

No description

appName
optional
string<string>

No description

details
optional

No description

sheetId
optional
string<string>

No description

spaceId
optional
string<string>

No description

started
optional
string<date-time>

No description

version
optional
number

No description

metadata
optional

No description

tenantId
optional
string<string>

No description

appItemId
optional
string<string>

No description

timestamp
optional
string<date-time>

No description

sheetTitle
optional
string<string>

No description

evaluations

object

Properties

links
optional

No description

evaluations
optional

No description

event

object

Properties

details
optional
string

No description

sheetId
optional
string

No description

objectId
optional
string

No description

severity
optional
string

No description

errorCode
optional
string

No description

objectType
optional
string

No description

sheetTitle
optional
string

No description

objectTitle
optional
string

No description

objectVisualization
optional
string

No description

metadata

object

Properties

reloadmeta
optional

No description

amountofrows
optional
number

No description

amountoffields
optional
number

No description

amountoftables
optional
number

No description

staticbytesize
optional
number

No description

hassectionaccess
optional
boolean

No description

amountoffieldvalues
optional
number

No description

amountofcardinalfieldvalues
optional
number

No description

objectmetrics

object

Properties

cpuSeconds
optional
Array<number>

No description

cpuQuotients
optional
Array<number>

No description

responseTimeSeconds
optional
number

No description

objectspec

object

Properties

id
optional
string<string>

No description

title
optional
string<string>

No description

sheetId
optional
string<string>

No description

objectType
optional
number

No description

objecttopspec

object

Properties

name
optional
string<string>

No description

byte_size
optional
number

No description

is_system
optional
boolean

No description

PostBody

object

Properties

appId
optional
string

The app guid of the app

itemId
optional
string

The item id of the app in collection service

result

object

Properties

sheets
optional

No description

objHeavy
optional

No description

rowCount
optional
number

No description

objNoCache
optional

No description

sheetCount
optional
number

No description

fileSizeMiB
optional
number

No description

objectCount
optional
number

No description

maxMemoryMiB
optional
number

No description

objSlowCached

No description

documentSizeMiB
optional
number

No description

objSlowUncached
optional

No description

dataModelSizeMiB
optional
number

No description

hasSectionAccess
optional
boolean

No description

topFieldsByBytes

No description

topTablesByBytes

No description

objSingleThreaded
optional

No description

appOpenTimeSeconds
optional
number

No description

resultentry

Properties

id
optional
string<string>

No description

title
optional
string<string>

No description

sheetId
optional
string<string>

No description

objectType
optional
number

No description

passes
optional

No description

resultmetadatatopfields

Properties

name
optional
string

No description

byte_size
optional
number

No description

is_system
optional
boolean

No description

cardinal
optional
number

No description

total_count
optional
number

No description

resultmetadatatoptables

Properties

name
optional
string

No description

byte_size
optional
number

No description

is_system
optional
boolean

No description

no_of_rows
optional
number

No description

resultobjheavy

Properties

id
optional
string<string>

No description

title
optional
string<string>

No description

sheetId
optional
string<string>

No description

objectType
optional
number

No description

cpuSeconds1
optional
number

No description

cpuSeconds2
optional
number

No description

cpuQuotient1
optional
number

No description

cpuQuotient2
optional
number

No description

resultobjresponsetime

Properties

id
optional
string<string>

No description

title
optional
string<string>

No description

sheetId
optional
string<string>

No description

objectType
optional
number

No description

responseTimeSeconds1
optional
number

No description

responseTimeSeconds2
optional
number

No description

resultobjsheet

object

Properties

sheet

No description

objectCount
optional
number

No description

sheetObjects
optional

No description

resultobjsinglethreaded

Properties

id
optional
string<string>

No description

title
optional
string<string>

No description

sheetId
optional
string<string>

No description

objectType
optional
number

No description

schema
optional

No description

cpuQuotients1
optional
Array<number>

No description

cpuQuotients2
optional
Array<number>

No description

responseTimeSeconds1
optional
number

No description

responseTimeSeconds2
optional
number

No description

v0.574.0
Was this page helpful?