View Delivery Basic report

GET https://api.ocamba.com/v1/hood/reports/delivery

Delivery Basic report enables analysis of critical parameters and essential information like Delivery Date, Delivery rate, Success rate, Error rate

Tip

Sortable fields are: delivery_date, tag_id, tag_name, container_id, container_name, task_id, task_name, provider_type, provider_id, provider_name, integration_id, integration_name, total_user, delivered, undelivered, success, failed, provider_failed, total_failed, success_rate, delivery_rate, error_rate, provider_error_rate, failure_rate, avg_delivery_duration, click, spam_click, total_click, total_profile.

Filterable fields are: delivery_date, tag_id, tag_name, container_id, container_name, task_id, task_name, provider_type, provider_id, provider_name, integration_id, integration_name, total_user, delivered, undelivered, success, failed, provider_failed, total_failed, success_rate, delivery_rate, error_rate, provider_error_rate, failure_rate, avg_delivery_duration, click, spam_click, total_click, total_profile.

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.

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

When filtering stat_date, use one of the following formats:

Single format: YYYY-mm-dd;

Displaying stats for this specific day
Range format: rf:YYYY-mm-dd,YYYY-mm-dd;
Requires usage of the range operators:
- r - range - The value must be in a specified open range, where both endpoints are excluded.
- rf - range full - The value must be in a specified closed range, where both endpoints are included.
- rl - range left - The value must be in a specified half-open range, where only left or start point is included.
- rr - range right - The value must be in a specified half-open range, where only right or end point is included.
  
  Displaying stats in this specific range.
Hour range format: rl: YYYY-mm-dd hh:00:00,YYYY-mm-dd hh:00:00
If you exclude this parameter, the default setup displays “today” stats.

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/delivery" \
  -H "Authorization: Bearer {TOKEN}"

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

[
  {
    "task_id": "100477",
    "delivery_date": "2022-08-05T00:00:00Z",
    "total_user": 0,
    "push_unsubscriptions": 0,
    "delivered": 0,
    "failed": 0
  },
  {
    "task_id": "15432861",
    "task_name": "16596949165579907044",
    "delivery_date": "2022-08-05T00:00:00Z",
    "total_user": 1,
    "push_unsubscriptions": 0,
    "delivered": 1,
    "failed": 0
  }
]

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