View Report

GET /reports/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/reports/{id}

Retrieves the details of a Report that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ report ]
An array of all created items.
Report
Name
Description
app_idstring
The ID of the application, assigned by Ocamba API.
company_idstring
The ID of the company, assigned by Ocamba API.


Example: 12345678
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
creator_idstring
The ID of the creator, assigned by Ocamba API.
descriptionstring
The detailed report description. Minimum length 5. Maximum length 1000.


Example: Displays top 10 exchanges with highest income
dsobject
Report configuration.


Example: { "fields": "exchange_name,income", "source": "adex.exchange", "limit": "10", "order": { "field" : "income", "op" : "-" } }
idstring (uuid)
The ID of the report, generated by Ocamba API.


Example: 132
namestring
The widget name. Minimum length 1. Maximum length 100.


Example: Top 10
refstring
Ref field is related only with system reports.
systeminteger
Indicates whether the report is system or user defined. Note that system reports can't be deleted or modified.

Possible values: 1 | 0
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
totalinteger
A total number of items.


Example: 1
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "132",
      "company_id": "12345678",
      "name": "Top 10",
      "description": "Displays top 10 exchanges with highest income",
      "ds": "{ \"fields\": \"exchange_name,income\", \"source\": \"adex.exchange\", \"limit\": \"10\", \"order\": { \"field\" : \"income\", \"op\" : \"-\" } }",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}