List Quick Reports

List Quick Reports

GET https://api.ocamba.com/v1/hood/quick-reports
Returns a list of Quick Reports.

Tip

Sortable fields are: id, name, deprecated, create_time and update_time.

Filterable fields are: id, creator_id, ref, name, system, type, labels, deprecated create_time and update_time.

Searchable fields are: name and description.

Rate limits:

  • Burst: 10/s
  • Steady: 150/m

Query parameters

parameters

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/quick-reports" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/quick-reports';
const options = {
  method: 'GET',
  headers: {
    Authorization: `Bearer {TOKEN}`
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
$ch = curl_init("https://api.ocamba.com/v1/hood/quick-reports");
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

{
  "total": 5,
  "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": [
        "Campaigns",
        "Top Channels"
      ],
      "deprecated": 1,
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

400 Bad Request

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

500 Internal Server Error

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