View Quick Report definition

View Quick Report definition

GET https://api.ocamba.com/v1/hood/quick-reports/{id}

Retrieves the details of Quick Report.

Rate limits:

Burst: 10/s
Steady: 150/m

Path parameters

parameters

Query parameters

parameters

Response schemas

GET https://api.ocamba.com/v1/hood/quick-reports/{id} HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
curl -X GET "https://api.ocamba.com/v1/hood/quick-reports/{id}" \
  -H "Authorization: Bearer $TOKEN"
fetch("https://api.ocamba.com/v1/hood/quick-reports/{id}", {
  method: "GET",
  headers: { Authorization: `Bearer ${TOKEN}` }
}).then(r => r.json());
$ch = curl_init("https://api.ocamba.com/v1/hood/quick-reports/{id}");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $token"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

200 OK

HTTP/1.1 200 OK
Content-Type: application/json

{
  "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\" : \"-\" } }",
      "type": "flat_table",
      "labels": [
        null
      ],
      "deprecated": 1,
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

400 Bad Request

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

500 Internal Server Error

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "code": 500,
  "title": "Internal server error.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
Responses

Tip
1
If you don’t know the id, list the Quick Reports to find it.