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.

Rate limits:

Burst: 10/s
Steady: 150/m

Query parameters

parameters

Response schemas

GET https://api.ocamba.com/v1/hood/reports/experiments/basic HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
curl -X GET "https://api.ocamba.com/v1/hood/reports/experiments/basic" \
  -H "Authorization: Bearer $TOKEN"
fetch("https://api.ocamba.com/v1/hood/reports/experiments/basic", {
  method: "GET",
  headers: { Authorization: `Bearer ${TOKEN}` }
}).then(r => r.json());
$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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "run_date": "2025-03-04T07:00:00Z",
  "experiment_id": 1002600,
  "experiment_name": "Blackfriday Worldwide",
  "resource": "prompt",
  "type": "push",
  "country_code": "RS",
  "country_name": "Serbia",
  "message_id": 1001,
  "message_name": "Message Name Example",
  "variant": "A",
  "winning_template_name": "Template Sms Black Friday Sale",
  "click": 9,
  "spam_click": 9,
  "total_click": 9,
  "opened": 5,
  "delivered": 888248,
  "open_rate": 55.56,
  "click_rate": 12.34
}
Responses

Tip
1
Sortable fields are: run_date, experiment_id, experiment_name, resource, type, country_code, country_name, message_id, message_name, variant, winning_template_name, opened, total_click, spam_click, click, delivered, click_rate, open_rate.
2
Filterable fields are: run_date, experiment_id, experiment_name, resource, type, country_code, country_name, message_id, message_name, variant, winning_template_name, opened, total_click, spam_click, click, delivered, click_rate, open_rate.
3
API provided filling empty entry points in between first and last date/hour. You should set with_fill parameter to true, but just in case the date dimension is requested only. It is in relation with resolution. You should pass day or hour, which defines what type of breakdown you request, default setup displays daily breakdown.
4
To get data by the time in your local time zone, you should set tz query parameter to the specific time zone. See the list of valid time zones here -> https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List.
5
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.
Note
1
When filtering stat_date, use one of the following formats:
2
  • Single format: YYYY-mm-dd;

3
Displaying stats for this specific day
4
  • Range format: rf:YYYY-mm-dd,YYYY-mm-dd;
5
Requires usage of the range operators:
6
  • r - range - The value must be in a specified open range, where both endpoints are excluded.
7
  • rf - range full - The value must be in a specified closed range, where both endpoints are included.
8
  • rl - range left - The value must be in a specified half-open range, where only left or start point is included.
9
  • rr - range right - The value must be in a specified half-open range, where only right or end point is included.

10
Displaying stats in this specific range.
11
  • Hour range format: rl: YYYY-mm-dd hh:00:00,YYYY-mm-dd hh:00:00
12
If you exclude this parameter, the default setup displays “today” stats.