List Deals

List Deals

GET https://api.ocamba.com/v1/hood/deals
Returns a list of Deals

Rate limits:

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

Query parameters

parameters

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/deals" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/deals';
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/deals");
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": "31",
    "items": [
       {
          "id": "1000254",
          "company_id": "6197120",
          "name": "latest deal",
          "description": "second description",
          "status": "active",
          "effective_status": "active",
          "postback": "https://dev-t.ocmhood.com/conv?click_id={OCMH_CLICK_ID}&price={PRICE}&currency={CURRENCY}&ref={REFERENCE}&event={EVENT}&device={DEVICE}&session_id={SESSION_ID}",
          "frequency_cap": {
            "max_value": 12,
            "per_unit": "week"
          },
          "clickthrough": false,
          "time_window": 3600,
          "country_price": {
              "RS": 13.11
          },
          "base_price": 1.44,
          "system": 0,
          "base_price_priority": false,
          "create_time": "2024-07-18 11:37:08",
          "update_time": "2024-07-18 11:37:08"
      },
      {
          "id": "1000252",
          "company_id": "6197120",
          "name": "new other deal",
          "description": "first description",
          "status": "active",
          "effective_status": "active",
          "postback": "https://dev-t.ocmhood.com/conv?click_id={OCMH_CLICK_ID}&price={PRICE}&currency={CURRENCY}&ref={REFERENCE}&event={EVENT}&device={DEVICE}&session_id={SESSION_ID}",
          "frequency_cap": {
            "max_value": 6,
            "per_unit": "month"
          },
          "clickthrough": false,
          "time_window": 3600,
          "country_price": {
              "RS": 22.31
          },
          "base_price": 1.12,
          "system": 0,
          "base_price_priority": false,
          "create_time": "2024-07-18 11:28:23",
          "update_time": "2024-07-18 11:39:12"
      },
      {
          "id": "1000251",
          "company_id": "6197120",
          "name": "another deal",
          "description": "another example description",
          "status": "active",
          "effective_status": "active",
          "postback": "https://dev-t.ocmhood.com/conv?click_id={OCMH_CLICK_ID}&price={PRICE}&currency={CURRENCY}&ref={REFERENCE}&event={EVENT}&device={DEVICE}&session_id={SESSION_ID}",
          "frequency_cap": {
            "max_value": 124,
            "per_unit": "day"
          },
          "clickthrough": false,
          "time_window": 3600,
          "country_price": {
              "RS": 12.1
          },
          "base_price": 1.12,
          "system": 0,
          "base_price_priority": true,
          "create_time": "2024-07-18 11:27:55",
          "update_time": "2024-07-18 11:27:55"
      },
    ]
}

400 Bad Request

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body 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
Tip
Filterable fields are name, system, status, clickthrough, time_window, base_price_priority and archived.