Reports Object

Introduction

You can use this object to manage errors and performance reports. You can send any data for errors and performance reporting. If you have any questions about reporting module - please, go to the Ocugine Forums.

Reports Available Methods

SendErrorReport

This method requires Project ID and Client Key

API Url:

https://cp.ocugine.pro/api/reports/send_error/

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
name (required) string Error Name
code (required) string Short Error Code
body (required) string Full Error report Body
platform (required) string Platform Value. You can use any platform name.
critical int Critical Code. 1 = critical, 0 = non critical

Response Example:

{
    "complete" : true,
    "message" : "",
    "data" : []
}

GetErrorReport

This method requires Project ID and Client Key

API Url:

https://cp.ocugine.pro/api/reports/get_error/

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
uid (required) double Error UID

Response Example:

{
    "complete": true,
    "message": "",
    "data": {
        "uid": "4",
        "project_id": "59",
        "title": "Test",
        "code": "error",
        "body": "This is a test for error reporting",
        "platform": "windows",
        "critical": "1",
        "time": "1568946714"
    }
}

SendPerformanceReport

This method requires Project ID and Client Key

API Url:

https://cp.ocugine.pro/api/reports/send_performance/

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
name (required) string Report Name
body (required) string Performance Report Body

Response Example:

{
    "complete" : true,
    "message" : "",
    "data" : []
}

GetPerformanceReport

This method requires Project ID and Client Key

API Url:

https://cp.ocugine.pro/api/reports/get_performance/

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
uid (required) double Performance Report UID

Response Example:

{
    "complete": true,
    "message": "",
    "data": {
        "uid": "2",
        "project_id": "59",
        "title": "Test",
        "body": "here can be stored performance data",
        "time": "1568946758"
    }
}