1. Home
  2. Docs
  3. API Documentation
  4. Reports
  5. DownloadReport

DownloadReport

Route: https://api.kayran.live/DownloadReport

This function permits downloading a specific report via its UUID.

This function requires both Admin and User roles. Private Users are restricted to fetching only the reports they initiated.

Request Syntax

{

"apiKey": "string",

"uuid": "String"

}


Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your Kayran given API Key.

How do I get it ? :

Located in the “Profile” section.

Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.

Type :

String

Is it Optional ? :

No.


Parameter Name :

uuid

Parameter Usage and Options :

The report’s uuid.

How do I get it ? :

Send a request to api endpoint: “GetReports”, you’ll then recieve “uuid” parameter.
Use it to get the desired report to download.

Type :

String

Is it Optional ? :

No.


Successful Response

file content

Errors and their Possible Causes

For more information, please refer to the General Errors section.