analyses/{id}

'Update, get details of given analysis of an reporting app.'

Note: When making API requests, ensure the following headers are included:

  • Authorization: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer Actions on a user section.
  • Content-Type: application/json
  • Accept: application/json

Note: To use this API, you must have the REPORTS_VIEW permission assigned.

Get details of the given analysis of reporting app.

Path Parameters

  • tenantIdstringrequired

    Describes partnerId or clientId of the tenant

  • idstringrequired

    Describes analysis uuid of the analyses of the reporting app

Responses

  • idstring

    Analysis uuid

  • namestringrequired

    Analysis name

  • tenantIdstring

  • appIdstringrequired

    Installed reporting appId

  • parametersobjectrequired

    Parameters as defined in the reporting app manifest.

  • createdByobject

  • updatedByobject

  • createdDatestring

    Analysis created date

Loading Examples...

Note: To use this API, you must have the REPORTS_MANAGE permission assigned.

Update the analysis of reporting app

Path Parameters

  • tenantIdstringrequired

    Describes partnerId or clientId of the tenant

  • idstringrequired

    Describes analysis uuid of the analyses of the reporting app

Request Body

application/json

  • namestringrequired

Loading Examples...

Responses

  • idstring

    analysisId of the analysis.

Loading Examples...