Route: https://api.kayran.live/GetReports
This function provides access to view the queue of reports.
This function requires both Admin and User roles. Private Users are restricted to fetching only the reports they initiated.
Request Syntax
{
"apiKey": "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.
Successful Response
{
“Error”: “Got all reports”,
“Function”: “GetReports”,
“Data”: [
{
“uuid”: “XXXXXXXX-1111-XXXX-XXXX-XXXXXXXXX111”,
“date”: “01-01-0000 | 00:00:00”,
“name”: “Target: exemple.com”,
“status”: “Completed”,
“content_type”: “application/vnd.openxmlformats-officedocument.wordprocessingml.document”,
“created_by”: “User name”,
“ext”: “docx”,
“report_security”: “False”,
“permission”: “Ok”
}
]
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.