View Settings

View Settings

GET https://api.ocamba.com/v1/hood/settings
Display Hood Engage settings

Rate limits:

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

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/settings" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/settings';
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/settings");
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

{
  "company_id": "1000000",
  "engagement_score": {
    "low_engagement": {
      "from": 12,
      "to": 25
    },
    "medium_engagement": {
      "from": 12,
      "to": 25
    },
    "high_engagement": {
      "from": 12,
      "to": 25
    },
    "advanced_settings": {
      "purchase": 100,
      "sms_click": 20,
      "web_push_click": 20
    }
  },
  "create_time": "2021-10-29 12:47:00",
  "update_time": "2021-10-30 14:27:26"
}

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