runs

Search and creates runs of reporting app.

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

  • Authorization: Bearer UserToken (replace UserToken with your actual access token)
  • Content-Type: application/json
  • Accept: application/json

Search runs of reporting app.

Path Parameters

  • tenantIdstringrequired

    Describes partnerId or clientId of the tenant

Query Parameters

  • installedAppIdstring

    Filter based on reporting appId

  • statusstring

    The current status of the run

    Enum:
    pendingfailedrunningcompleted
  • sortOrderboolean

    Sorting order of the resultset. 'True' for descendingOrder

  • sortBystring

    Sorting fields by id, status, createdDate, installedAppId

  • analysisIdstring

    Filter runs by analysis id

Responses

  • resultsarray

  • totalResultsinteger

  • orderBystring

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • previousPageNointeger

  • descendingOrderboolean

Loading Examples...

Create run of an reporting app.

Path Parameters

  • tenantIdstringrequired

    Describes partnerId or clientId of the tenant

Request Body

application/json

  • parametersobject

  • installedAppIdstring

  • formatarray of strings

  • analysisIdstring

Loading Examples...

Responses

Loading Examples...