Skip to content

evaluations

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

Endpoints

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

Queue an app evaluation

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.

Request Body POST /evaluations

application/json

The parameters of the evaluation

Responses POST /evaluations

201
application/json

App evaluation queued.

400
application/json

Bad request, incorrect body.

403
application/json

User lacks permissions to evaluate app.

500
application/json

Internal server error.

POST/evaluations

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

Request POST /evaluations

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

Response POST /evaluations

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

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

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

Query Parameters GET /evaluations

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

Number of results to return per page.

itemId
optional
string

The app item id.

appId
optional
string

The app guid.

next
optional
string

The app evaluation id to get next page from

prev
optional
string

The app evaluation id to get previous page from

all
optional
boolean

Get the full data of the evaluation

format
optional
string

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

fileMode
optional
boolean

Add file transfer headers to response

Responses GET /evaluations

200
application/json

Evaluation(s) retrieved successfully.

404
application/json

Not Found.

500
application/json

Internal server error.

GET/evaluations

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

Response GET /evaluations

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

Retrieve a specific evaluation

Find an evaluation by a specific id.

Path Parameters GET /evaluations/{id}

id
string

Id of the desired evaluation.

Query Parameters GET /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 /evaluations/{id}

200
application/json

Evaluation(s) retrieved successfully.

404
application/json

Not Found.

500
application/json

Internal server error.

GET/evaluations/{id}

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

Response GET /evaluations/{id}

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

Download a detailed XML log of a specific evaluation

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

Path Parameters GET /evaluations/{id}/download

id
string

Id of the desired evaluation.

Responses GET /evaluations/{id}/download

200
application/xml

Evaluation(s) retrieved successfully.

404
application/json

Not Found.

500
application/json

Internal server error.

GET/evaluations/{id}/download

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

Response GET /evaluations/{id}/download

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

PostBody

object

Properties

itemId
string

The item id of the app in collection service

appId
string

The app guid of the app

Error

object

Properties

errors

No description

defaultResponse

object

Properties

code
string<integer>

No description

message
string<string>

No description

evaluation

object

Properties

id
string<string>

No description

version
number

No description

timestamp
string<date-time>

No description

started
string<date-time>

No description

ended
string<date-time>

No description

appId
string<string>

No description

appItemId
string<string>

No description

appName
string<string>

No description

spaceId
string<string>

No description

status
string<string>

No description

tenantId
string<string>

No description

sheetId
string<string>

No description

sheetTitle
string<string>

No description

userId
string<string>

No description

events

No description

result
optional

No description

metadata
optional

No description

details
optional

No description

event

object

Properties

severity
string

No description

errorCode
string

No description

details
string

No description

objectId
string

No description

objectType
string

No description

objectVisualization
string

No description

objectTitle
string

No description

sheetId
string

No description

sheetTitle
string

No description

evaluations

object

Properties

evaluations

No description

links
optional

No description

objectmetrics

object

Properties

responseTimeSeconds
number

No description

cpuSeconds
Array<number>

No description

cpuQuotients
Array<number>

No description

objectspec

object

Properties

id
string<string>

No description

objectType
number

No description

sheetId
string<string>

No description

title
string<string>

No description

objecttopspec

object

Properties

name
string<string>

No description

is_system
boolean

No description

byte_size
number

No description

resultentry

Properties

id
string<string>

No description

objectType
number

No description

sheetId
string<string>

No description

title
string<string>

No description

passes

No description

result

object

Properties

maxMemoryMiB
number

No description

documentSizeMiB
number

No description

fileSizeMiB
number

No description

appOpenTimeSeconds
number

No description

objectCount
number

No description

sheetCount
number

No description

rowCount
number

No description

dataModelSizeMiB
number

No description

hasSectionAccess
boolean

No description

sheets

No description

objNoCache

No description

objSlowUncached

No description

objSlowCached

No description

objSingleThreaded

No description

objHeavy

No description

topTablesByBytes

No description

topFieldsByBytes

No description

resultobjsheet

object

Properties

sheet

No description

sheetObjects

No description

objectCount
number

No description

resultobjresponsetime

Properties

id
string<string>

No description

objectType
number

No description

sheetId
string<string>

No description

title
string<string>

No description

responseTimeSeconds1
number

No description

responseTimeSeconds2
number

No description

resultobjheavy

Properties

id
string<string>

No description

objectType
number

No description

sheetId
string<string>

No description

title
string<string>

No description

cpuQuotient1
number

No description

cpuQuotient2
number

No description

cpuSeconds1
number

No description

cpuSeconds2
number

No description

resultobjsinglethreaded

Properties

id
string<string>

No description

objectType
number

No description

sheetId
string<string>

No description

title
string<string>

No description

schema

No description

responseTimeSeconds1
number

No description

responseTimeSeconds2
number

No description

cpuQuotients1
Array<number>

No description

cpuQuotients2
Array<number>

No description

resultmetadatatoptables

Properties

name
string

No description

is_system
boolean

No description

byte_size
number

No description

no_of_rows
number

No description

resultmetadatatopfields

Properties

name
string

No description

is_system
boolean

No description

byte_size
number

No description

total_count
number

No description

cardinal
number

No description

metadata

object

Properties

staticbytesize
number

No description

hassectionaccess
boolean

No description

amountoffields
number

No description

amountoftables
number

No description

amountofrows
number

No description

amountofcardinalfieldvalues
number

No description

amountoffieldvalues
number

No description

reloadmeta
optional

No description

comparison

object

Properties

maxMemoryMib

No description

documentSizeMib

No description

fileSizeMib

No description

appOpenTimeSeconds

No description

objectCount

No description

sheetCount

No description

rowCount

No description

dataModelSizeMib

No description

hasSectionAccess

No description

sheetsUncached

No description

sheetsCached

No description

objNoCache

No description

objSlowUncached

No description

objSlowCached

No description

objSingleThreaded

No description

objHeavy

No description

topTablesByBytes

No description

topFieldsByBytes

No description

sortedcomparisonobjresponsetime

Properties

relativeDiffAsc

No description

relativeDiffDesc

No description

absoluteDiffAsc

No description

absoluteDiffDesc

No description

list

No description

dataSourceStatus
string

No description

Enum:

full

none

baselinemissing

comparisonmissing

comparisonobjresponsetime

Array<>

sortedcomparisonoobjheavy

Properties

relativeDiffAsc

No description

relativeDiffDesc

No description

absoluteDiffAsc

No description

absoluteDiffDesc

No description

list

No description

dataSourceStatus
string

No description

Enum:

full

none

baselinemissing

comparisonmissing

comparisonoobjheavy

Array<>

sortedcomparisontables

Properties

relativeDiffAsc

No description

relativeDiffDesc

No description

absoluteDiffAsc

No description

absoluteDiffDesc

No description

list

No description

dataSourceStatus
string

No description

Enum:

full

none

baselinemissing

comparisonmissing

comparisontables

Array<>

sortedcomparisonfields

Properties

relativeDiffAsc

No description

relativeDiffDesc

No description

absoluteDiffAsc

No description

absoluteDiffDesc

No description

list

No description

dataSourceStatus
string

No description

Enum:

full

none

baselinemissing

comparisonmissing

comparisonfields

Array<>

classification

Properties

absoluteDiff
number

No description

diff
number

No description

trend
string

No description

cmpfloat

Properties

baseline
number

No description

comparison
number

No description

cmpint

Properties

baseline
number

No description

comparison
number

No description

cmpbool

Properties

baseline
boolean

No description

comparison
boolean

No description

v1.6.0
Was this page helpful?