View Experiment Basic report

View Experiment Basic report

GET https://api.ocamba.com/v1/hood/reports/experiments/basic
The Experiment Basic Report provides a high-level overview of profile engagement across campaigns, modals, and prompts that are part of A/B experiments. It tracks key performance metrics such as opens, clicks, and spam clicks, grouped by experiment, resource type, channel, and others. This report is designed to help teams understand how different experiment variants are performing in terms of profile interaction and engagement, and to support data-driven decisions when evaluating experiment results.

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

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

[
  {
    "run_date": "2025-07-04T08:29:57Z",
    "experiment_id": "2133",
    "experiment_name": "Experiment Test",
    "resource": "campaign",
    "type": "push",
    "total_click": 200,
    "delivered": 320,
    "click_rate": 62.5,
    "open_rate": 0
  },
  {
    "run_date": "2025-07-04T09:43:00Z",
    "experiment_id": "2131",
    "experiment_name": "Email Experiment",
    "resource": "campaign",
    "type": "email",
    "total_click": 12,
    "delivered": 200,
    "click_rate": 6.0,
    "open_rate": 22.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