Create Report

POST /reports
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/reports

Creates a new Report object

Request Body Schema
Arrow
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
Response status codes
Arrow
201 - Created
Arrow
Request examples
Copied
Arrow
post Arrow
  • post
{
  "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"
}