View Modal Nps Raw report

GET https://api.ocamba.com/v1/hood/reports/modals/nps

The NPS Modal Raw Report provides event-level data for all user interactions with NPS modals, including displays, closures, submissions, and errors, along with full contextual metadata.

Tip

For easier search, Reports API gives you the possibility of using one of the following labels: today, yesterday, last-7-days, last-30-days, last-24-hours, this-month, last-month, current-hour, last-hour, last-48-hours, last-2-days, month-to-date, month-to-yesterday, quarter-to-date.

Rate limits:

Burst: 10/s
Steady: 150/m

Query parameters

parameters

Response schemas

›

200

application/json

›

400

application/json

›

500

application/json

curl -X GET \
 "https://api.ocamba.com/v1/hood/reports/modals/nps" \
  -H "Authorization: Bearer {TOKEN}"

const url = 'https://api.ocamba.com/v1/hood/reports/modals/nps';
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/reports/modals/nps");
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

[
  {
    "modal_id": "1030451",
    "modal_type": "nps",
    "score": "2"
  },
  {
    "modal_id": "1001",
    "modal_type": "nps",
    "score": "6"
  },
  {
    "modal_id": "1030152",
    "modal_type": "nps",
    "score": "7"
  },
]

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

LinkedIn Facebook Instagram