View a Feedback instance

View a Feedback instance

GET https://api.ocamba.com/v1/hood/feedback-instances/{id}
Retrieves the details of a Feedback instance that has previously been created if a valid identifier was provided

Tip
If you don’t know the feedback instance id, list the instances to find it.

Rate limits:

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

Path parameters

parameters

Query parameters

parameters

Response schemas

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

{
  "total": 1,
  "items": [
    {
      "id": "1000000",
      "company_id": "1000001",
      "container_id": "32423",
      "modal_id": "1000424",
      "message_id": "1000424",
      "page_id": "qj12ak12",
      "instance_id": "poq124al2",
      "name": "Customer satisfaction survey",
      "type": "qa",
      "status": "unpublished",
      "components": [
        {
          "id": "1000000",
          "company_id": "1000001",
          "page_id": "qj12ak12",
          "instance_id": "1000210",
          "component_id": "poq124al2",
          "type": "qa",
          "create_time": "2021-07-30 12:50:13",
          "update_time": "2021-07-30 12:50:13"
        }
      ],
      "stats": {
        "modal_id": "1000892",
        "avg_score": 6.5,
        "response_rate": 35.9,
        "profiles": 142,
        "completion_rate": 55.2,
        "first_views": 87,
        "bounce_rate": 15.3,
        "completed_responses": 139,
        "uncompleted_responses": 21,
        "canceled_responses": 7,
        "total_responses": 167,
        "comments": 99
      },
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

500 Internal Server Error

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