runs/{id}/downloads

Downloads analysis against a given run in the supported formats.

Dowloads run analysis.

Example URL

  • {base_url}/analytics/api/v3/tenants/{tenantId}/runs/{runId}/downloads?format=pdf
  • Downloads a given format at a time.
  • supported response headers. To be used based on the format chosen to download
    • application/pdf
    • application/xlsx

Path Parameters

  • tenantIdstringrequired

    Describes partnerId or clientId of the tenant

  • idstringrequired

    Describes run uuid of runs on the reporting app

Query Parameters

  • formatstring

    Supported format for analysis downloads

    Enum:
    xlsxpdf

Responses

Response Headers

  • Content-Dispositionstring

    Report download in the supported format .

    Enum:
    attachment; filename="{{app_name}}.{{time_stamp}}.pdf"attachment; filename="{{app_name}}.{{time_stamp}}.xlsx"attachment; filename="{{app_name}}.{{time_stamp}}.csv"
  • Pragmastring

    Cache

    Default: cache

  • Cache-Controlstring

    Cache Control

    Default: cache

  • Content-Encodingstring

    Report content encoding format

    Default: ISO-8859-1

Loading Examples...